[Python-checkins] devguide: Cleanup

Sun Jan 23 01:56:56 CET 2011

brett.cannon pushed 00a556903d82 to devguide:

http://hg.python.org/devguide/rev/00a556903d82
changeset:   186:00a556903d82
tag:         tip
user:        Brett Cannon <brett at python.org>
date:        Sat Jan 22 16:56:41 2011 -0800
summary:
  Cleanup

files:
  committing.rst
  conf.py
  coredev.rst
  runtests.rst
  triaging.rst

diff --git a/committing.rst b/committing.rst
--- a/committing.rst
+++ b/committing.rst
@@ -8,7 +8,7 @@
 
 First, make sure the patch in a good state. Both :ref:`patch` and
 :ref:`helptriage`
-explain what is to be expected of a patch. Typically patches that get passed by
+explain what is to be expected of a patch. Typically patches that get cleared by
 triagers are good to go except maybe lacking ``Misc/ACKS`` and ``Misc/NEWS``
 entries.
 
diff --git a/conf.py b/conf.py
--- a/conf.py
+++ b/conf.py
@@ -52,7 +52,7 @@
 # The short X.Y version.
 version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.0a0'
+release = '1.0b1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/coredev.rst b/coredev.rst
--- a/coredev.rst
+++ b/coredev.rst
@@ -23,7 +23,9 @@
 core developers think you need more time contributing patches before you are
 able to commit them without supervision.
 
-XXX list of people
+A complete list of core developer usernames can be found at
+http://www.python.org/dev/committers. :ref:`developers` lists when and why
+someone received commit privileges.
 
 
 Gaining Commit Privileges
@@ -58,7 +60,8 @@
 You need to generate an SSH 2 RSA key to be able to commit code. You may have
 multiple keys if you wish (e.g., for work and home). Send your key as an
 attachment in an email to python-committers (do not paste it in the email as
-SSH keys have specific formatting requirements).
+SSH keys have specific formatting requirements). Help in generating an SSH key
+can be found in the :ref:`faq`.
 
 Your SSH key will be set to a username in the form of "first_name.last_name".
 This should match your username on the issue tracker.
@@ -135,7 +138,7 @@
 tracker as well.
 
 Third, please list what areas you want to be considered an expert in the
-``experts.rst`` file (including stdlib modules). This allows triagers
+:ref:`experts`. This allows triagers
 to direct issues your way when they involve an area you are an expert in. But,
 as stated in the second point above, if you do not have the time to answer
 questions promptly then please remove yourself as needed from the file so that
diff --git a/runtests.rst b/runtests.rst
--- a/runtests.rst
+++ b/runtests.rst
@@ -4,7 +4,7 @@
 =======================
 
 .. note::
-    This document assumes you are working with Python 3.2 or higher. If you
+    This document assumes you are working from a checkout of Python. If you
     are not then some things presented here may not work as they may depend
     on new features not available in earlier versions of Python.
 
@@ -16,8 +16,8 @@
 
     ./python -m test
 
-This will run the majority of tests, but exclude a small portion of them.
-These are tests using special kinds of resources: for example, accessing the
+This will run the majority of tests, but exclude a small portion of them; these
+excluded tests use special kinds of resources: for example, accessing the
 Internet, or trying to play a sound or to display a graphical interface on
 your desktop.  They are disabled by default so that running the test suite
 is not too intrusive.  To enable some of these additional tests (and for
@@ -35,7 +35,7 @@
 If you have a multi-core or multi-CPU machine, you can enable parallel testing
 using several Python processes so as to speed up things::
 
-   ./python -m test -j4
+   ./python -m test -j2
 
 .. _strenuous_testing:
 
@@ -45,13 +45,15 @@
     ./python -bb -E -Wd -m test -r -w -uall
 
 The various extra flags passed to Python cause it to be much stricter about
-various things (the ``-Wd`` flag should be ``-We`` at some point, but the test
+various things (the ``-Wd`` flag should be ``-W error`` at some point, but the
+test
 suite has not reached a point where all warnings have been dealt with and so we
 cannot guarantee that a bug-free Python will properly complete a test run with
-``-We``). The ``-r`` flag to the test runner causes it to run more randomly
+``-W error``). The ``-r`` flag to the test runner causes it to run more randomly
 which helps assert that the various tests don't interfere against each other.
 The ``-w`` flag causes failures to run again to see if it a transient failure
-or a consistent one.
+or a consistent one. The ``-uall`` flag allows the user of all available
+resources so as to not skip tests requiring, e.g., Internet access.
 
 
 Writing
diff --git a/triaging.rst b/triaging.rst
--- a/triaging.rst
+++ b/triaging.rst
@@ -21,8 +21,8 @@
 
 Describes the type of issue.  If something does not fit within any
 specific type then simply do not set it.  *"Crash"* is for hard crashes of
-the Python interpreter - possibly with a core dump or a Windows error box -,
-not erroneous exits because of an unhandled exception (the latter fall under
+the Python interpreter -- possibly with a core dump or a Windows error box --
+and not erroneous exits because of an unhandled exception (the latter fall under
 the *"behaviour"* category).
 
 Stage
@@ -46,8 +46,7 @@
 Components
 ''''''''''
 What part of Python is affected by the issue. This is a multi-select field.
-Setting this properly is somewhat important as certain components lead to an
-auto-assignment of the issue to the proper people.
+Be aware what component is chosen may cause the issue to be auto-assigned.
 
 Versions
 ''''''''
@@ -113,7 +112,8 @@
 Who is expected to take the next step in resolving the issue. It is acceptable
 to assign an issue to someone if the issue cannot move forward without their
 help, e.g., they need to make a technical decision to allow the issue to move
-forward.
+forward. Also consult the :ref:`experts` as certain stdlib modules should
+always be assigned to a specific person.
 
 Dependencies
 ''''''''''''
@@ -142,7 +142,7 @@
 
 Resolution
 ''''''''''
-Why the issue is in its current state (which is other than "open", usually).
+Why the issue is in its current state (not usually used for "open").
 
 * accepted
     Submitted patch was applied, still needs verifying (for example by

--
Repository URL: http://hg.python.org/devguide
