summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2014-03-13 20:17:11 (GMT)
committerÉric Araujo <merwok@netwok.org>2014-03-13 20:17:11 (GMT)
commitef04c59f53390c2664e496a7a1f16f327f329145 (patch)
tree2a5b7b77a8a52822429b3c3f37b9b3419e51999e /Doc
parent782c4cf1553e46fdfbabc4bf627721a5df32ca55 (diff)
downloadcpython-ef04c59f53390c2664e496a7a1f16f327f329145.zip
cpython-ef04c59f53390c2664e496a7a1f16f327f329145.tar.gz
cpython-ef04c59f53390c2664e496a7a1f16f327f329145.tar.bz2
Clarify distutils’ clean command (ref #6142)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/distutils/apiref.rst6
-rw-r--r--Doc/distutils/configfile.rst2
2 files changed, 7 insertions, 1 deletions
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index d70d13f..9853f02 100644
--- 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 890047c..ac79671 100644
--- 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