[Python-checkins] cpython (2.7): Clarify distutils’ clean command (ref #6142)

[eric.araujo]

http://hg.python.org/cpython/rev/67ada6ab7fe2
changeset:   89642:67ada6ab7fe2
branch:      2.7
parent:      89636:b44a3f6676b8
user:        Éric Araujo <merwok at netwok.org>
date:        Thu Mar 13 16:17:11 2014 -0400
summary:
  Clarify distutils’ clean command (ref #6142)

files:
  Doc/distutils/apiref.rst     |  8 ++++++--
  Doc/distutils/configfile.rst |  2 ++
  2 files changed, 8 insertions(+), 2 deletions(-)


diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -1907,8 +1907,12 @@
 .. module:: distutils.command.clean
    :synopsis: Clean a package build area
 
-
-.. % todo
+This command removes the temporary files created by :command:`build`
+and its subcommands, like intermediary compiled object files.  With
+the ``--all`` option, the complete build directory will be removed.
+
+Extension modules built :ref:`in place <distutils-build-ext-inplace>`
+will not be cleaned, as they are not in the build directory.
 
 
 :mod:`distutils.command.config` --- Perform package configuration
diff --git a/Doc/distutils/configfile.rst b/Doc/distutils/configfile.rst
--- a/Doc/distutils/configfile.rst
+++ b/Doc/distutils/configfile.rst
@@ -69,6 +69,8 @@
 Note that an option spelled :option:`--foo-bar` on the command-line  is spelled
 :option:`foo_bar` in configuration files.
 
+.. _distutils-build-ext-inplace:
+
 For example, say you want your extensions to be built "in-place"---that is, you
 have an extension :mod:`pkg.ext`, and you want the compiled extension file
 (:file:`ext.so` on Unix, say) to be put in the same source directory as your

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