summaryrefslogtreecommitdiffstats
path: root/Doc/distutils
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)
commit01111e85b8038912ca0aa1e4c50d4c6effecaf61 (patch)
tree0630b6397643632c2c3c8a2afa6e31fe4d520589 /Doc/distutils
parent8f606a0d4ffc728e14d9d9e0c5a10d4305b77fd6 (diff)
downloadcpython-01111e85b8038912ca0aa1e4c50d4c6effecaf61.zip
cpython-01111e85b8038912ca0aa1e4c50d4c6effecaf61.tar.gz
cpython-01111e85b8038912ca0aa1e4c50d4c6effecaf61.tar.bz2
Clarify distutils’ clean command (ref #6142)
Diffstat (limited to 'Doc/distutils')
-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 7859aac..d1201ef 100644
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -1907,8 +1907,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