Clarify distutils’ clean command (ref #6142)

diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index d70d13f8b8bffd620a91d88753dae75ed070b7c8..9853f021ea576c3961aa22d03835255954427bd6 100644 (file)
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -1934,8 +1934,12 @@ Subclasses of :class:`Command` must define the following methods.
 .. module:: distutils.command.clean
    :synopsis: Clean a package build area
 
+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.
 
-.. % todo
+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
index 890047c08e54327f306c27eccd9d8b40492b31f4..ac79671611b6faf6a114e5033770859d37398425 100644 (file)
--- a/Doc/distutils/configfile.rst
+++ b/Doc/distutils/configfile.rst
@@ -69,6 +69,8 @@ universal :option:`--help` option, e.g. ::
 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