launchpad-reviewers team mailing list archive

[Colin Watson <mp+411453@xxxxxxxxxxxxxxxxxx>]

Colin Watson has proposed merging ~cjwatson/launchpad:document-setup-cfg into launchpad:master.

Commit message:
Update doc/pip.txt for setup.cfg

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~cjwatson/launchpad/+git/launchpad/+merge/411453
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~cjwatson/launchpad:document-setup-cfg into launchpad:master.

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.
 These are the items in or near the top-level Launchpad directory associated
 with pip:
 
-``setup.py``
-    This is the file that uses ``distutils``, extended by ``setuptools``, to
-    specify direct dependencies, scripts, and other elements of the local
+``setup.py``, ``setup.cfg``
+    These are the files that use ``distutils``, extended by ``setuptools``,
+    to specify direct dependencies, scripts, and other elements of the local
     source tree.
 
-    pip uses it, but the reverse is not true: ``setup.py`` does not know
-    about pip.
+    pip uses them, but the reverse is not true: ``setup.py`` and
+    ``setup.cfg`` do not know about pip.
 
-    Describing this file in full is well beyond the scope of this document.  We
-    will give recipes for modifying it for certain tasks below. For more
-    information beyond these recipes, see the setuptools and distutils
-    documentation.
+    Describing these files in full is well beyond the scope of this
+    document.  We will give recipes for modifying them for certain tasks
+    below. For more information beyond these recipes, see the setuptools and
+    distutils documentation.
 
 ``requirements/ztk-versions.cfg``
     This is a copy of the dependency versions file published by the `Zope
@@ -184,8 +184,8 @@ Add a Package
 
 Let's suppose that we want to add the "lazr.foo" package as a dependency.
 
-1.  Add the new package to the ``setup.py`` file in the ``install_requires``
-    list.
+1.  Add the new package to the ``setup.cfg`` file in the
+    ``install_requires`` list under ``[options]``.
 
     Generally, our policy is to only set minimum version numbers in this
     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
 dependencies, and sometimes even different Python executables.  Several of the
 scripts we have are specified using setuptools.
 
-For the common case, in ``setup.py``, add a string in the ``console_scripts``
-list of the ``entry_points`` argument. Here's an example string::
+For the common case, in ``setup.cfg``, add a string in the
+``console_scripts`` list under ``[options.entry_points]``. Here's an example
+string::
 
     'run = lp.scripts.runlaunchpad:start_launchpad'