From: Éric Araujo Date: Thu, 13 Mar 2014 20:17:11 +0000 (-0400) Subject: Clarify distutils’ clean command (ref #6142) X-Git-Tag: v2.7.7rc1~128 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=01111e85b8038912ca0aa1e4c50d4c6effecaf61;p=python Clarify distutils’ clean command (ref #6142) --- diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst index 7859aaca43..d1201efb24 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 ` +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 890047c08e..ac79671611 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