Merge ~cjwatson/launchpad:document-setup-cfg into launchpad:master

Proposed by Colin Watson
Status: Merged
Approved by: Colin Watson
Approved revision: 927b4b2c2d243c977cd0d81bf981be121e8e568d
Merge reported by: Otto Co-Pilot
Merged at revision: not available
Proposed branch: ~cjwatson/launchpad:document-setup-cfg
Merge into: launchpad:master
Diff against target: 54 lines (+14/-13)
1 file modified
doc/pip.txt (+14/-13)
Reviewer Review Type Date Requested Status
Jürgen Gmach Approve
Review via email: mp+411453@code.launchpad.net

Commit message

Update doc/pip.txt for setup.cfg

To post a comment you must log in.
Revision history for this message
Jürgen Gmach (jugmac00) wrote :

LGTM

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
diff --git a/doc/pip.txt b/doc/pip.txt
index 5726e2e..8c766c6 100644
--- a/doc/pip.txt
+++ b/doc/pip.txt
@@ -89,18 +89,18 @@ together we can come up with another approach that meets our needs better.
89These are the items in or near the top-level Launchpad directory associated89These are the items in or near the top-level Launchpad directory associated
90with pip:90with pip:
9191
92``setup.py``92``setup.py``, ``setup.cfg``
93 This is the file that uses ``distutils``, extended by ``setuptools``, to93 These are the files that use ``distutils``, extended by ``setuptools``,
94 specify direct dependencies, scripts, and other elements of the local94 to specify direct dependencies, scripts, and other elements of the local
95 source tree.95 source tree.
9696
97 pip uses it, but the reverse is not true: ``setup.py`` does not know97 pip uses them, but the reverse is not true: ``setup.py`` and
98 about pip.98 ``setup.cfg`` do not know about pip.
9999
100 Describing this file in full is well beyond the scope of this document. We100 Describing these files in full is well beyond the scope of this
101 will give recipes for modifying it for certain tasks below. For more101 document. We will give recipes for modifying them for certain tasks
102 information beyond these recipes, see the setuptools and distutils102 below. For more information beyond these recipes, see the setuptools and
103 documentation.103 distutils documentation.
104104
105``requirements/ztk-versions.cfg``105``requirements/ztk-versions.cfg``
106 This is a copy of the dependency versions file published by the `Zope106 This is a copy of the dependency versions file published by the `Zope
@@ -184,8 +184,8 @@ Add a Package
184184
185Let's suppose that we want to add the "lazr.foo" package as a dependency.185Let's suppose that we want to add the "lazr.foo" package as a dependency.
186186
1871. Add the new package to the ``setup.py`` file in the ``install_requires``1871. Add the new package to the ``setup.cfg`` file in the
188 list.188 ``install_requires`` list under ``[options]``.
189189
190 Generally, our policy is to only set minimum version numbers in this190 Generally, our policy is to only set minimum version numbers in this
191 file, or none at all. It doesn't really matter for an application like191 file, or none at all. It doesn't really matter for an application like
@@ -310,8 +310,9 @@ We often need scripts that are run in a certain environment defined by Python
310dependencies, and sometimes even different Python executables. Several of the310dependencies, and sometimes even different Python executables. Several of the
311scripts we have are specified using setuptools.311scripts we have are specified using setuptools.
312312
313For the common case, in ``setup.py``, add a string in the ``console_scripts``313For the common case, in ``setup.cfg``, add a string in the
314list of the ``entry_points`` argument. Here's an example string::314``console_scripts`` list under ``[options.entry_points]``. Here's an example
315string::
315316
316 'run = lp.scripts.runlaunchpad:start_launchpad'317 'run = lp.scripts.runlaunchpad:start_launchpad'
317318

Subscribers

People subscribed via source and target branches

to status/vote changes: