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
1diff --git a/doc/pip.txt b/doc/pip.txt
2index 5726e2e..8c766c6 100644
3--- a/doc/pip.txt
4+++ b/doc/pip.txt
5@@ -89,18 +89,18 @@ together we can come up with another approach that meets our needs better.
6 These are the items in or near the top-level Launchpad directory associated
7 with pip:
8
9-``setup.py``
10- This is the file that uses ``distutils``, extended by ``setuptools``, to
11- specify direct dependencies, scripts, and other elements of the local
12+``setup.py``, ``setup.cfg``
13+ These are the files that use ``distutils``, extended by ``setuptools``,
14+ to specify direct dependencies, scripts, and other elements of the local
15 source tree.
16
17- pip uses it, but the reverse is not true: ``setup.py`` does not know
18- about pip.
19+ pip uses them, but the reverse is not true: ``setup.py`` and
20+ ``setup.cfg`` do not know about pip.
21
22- Describing this file in full is well beyond the scope of this document. We
23- will give recipes for modifying it for certain tasks below. For more
24- information beyond these recipes, see the setuptools and distutils
25- documentation.
26+ Describing these files in full is well beyond the scope of this
27+ document. We will give recipes for modifying them for certain tasks
28+ below. For more information beyond these recipes, see the setuptools and
29+ distutils documentation.
30
31 ``requirements/ztk-versions.cfg``
32 This is a copy of the dependency versions file published by the `Zope
33@@ -184,8 +184,8 @@ Add a Package
34
35 Let's suppose that we want to add the "lazr.foo" package as a dependency.
36
37-1. Add the new package to the ``setup.py`` file in the ``install_requires``
38- list.
39+1. Add the new package to the ``setup.cfg`` file in the
40+ ``install_requires`` list under ``[options]``.
41
42 Generally, our policy is to only set minimum version numbers in this
43 file, or none at all. It doesn't really matter for an application like
44@@ -310,8 +310,9 @@ We often need scripts that are run in a certain environment defined by Python
45 dependencies, and sometimes even different Python executables. Several of the
46 scripts we have are specified using setuptools.
47
48-For the common case, in ``setup.py``, add a string in the ``console_scripts``
49-list of the ``entry_points`` argument. Here's an example string::
50+For the common case, in ``setup.cfg``, add a string in the
51+``console_scripts`` list under ``[options.entry_points]``. Here's an example
52+string::
53
54 'run = lp.scripts.runlaunchpad:start_launchpad'
55

Subscribers

People subscribed via source and target branches

to status/vote changes: