diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/install/install.rst | 2 | ||||
| -rw-r--r-- | Doc/library/packaging.compiler.rst | 10 | ||||
| -rw-r--r-- | Doc/library/packaging.util.rst | 2 |
3 files changed, 8 insertions, 6 deletions
diff --git a/Doc/install/install.rst b/Doc/install/install.rst index 33f3e9c..b88d3a6 100644 --- a/Doc/install/install.rst +++ b/Doc/install/install.rst @@ -842,6 +842,8 @@ Additionally, there's a ``global`` section for options that affect every command Sections consist of one or more lines containing a single option specified as ``option = value``. +.. XXX use dry-run in the next example or use a pysetup option as example + For example, here's a complete configuration file that forces all commands to run quietly by default:: diff --git a/Doc/library/packaging.compiler.rst b/Doc/library/packaging.compiler.rst index 10780d1..f23c551 100644 --- a/Doc/library/packaging.compiler.rst +++ b/Doc/library/packaging.compiler.rst @@ -15,7 +15,7 @@ function. Compiler types provided by Packaging are listed in Public functions ---------------- -.. function:: new_compiler(plat=None, compiler=None, verbose=0, dry_run=0, force=0) +.. function:: new_compiler(plat=None, compiler=None, dry_run=False, force=False) Factory function to generate an instance of some :class:`~.ccompiler.CCompiler` subclass for the requested platform or @@ -165,7 +165,7 @@ link steps needed to build a single project. Methods are provided to set options for the compiler --- macro definitions, include directories, link path, libraries and the like. -.. class:: CCompiler([verbose=0, dry_run=0, force=0]) +.. class:: CCompiler(dry_run=False, force=False) The abstract base class :class:`CCompiler` defines the interface that must be implemented by real compiler classes. The class also has some utility @@ -180,11 +180,11 @@ libraries and the like. per-compilation or per-link basis. The constructor for each subclass creates an instance of the Compiler object. - Flags are *verbose* (show verbose output), *dry_run* (don't actually execute + Flags are *dry_run* (don't actually execute the steps) and *force* (rebuild everything, regardless of dependencies). All - of these flags default to ``0`` (off). Note that you probably don't want to + of these flags default to ``False`` (off). Note that you probably don't want to instantiate :class:`CCompiler` or one of its subclasses directly - use the - :func:`packaging.CCompiler.new_compiler` factory function instead. + :func:`new_compiler` factory function instead. The following methods allow you to manually alter compiler options for the instance of the Compiler class. diff --git a/Doc/library/packaging.util.rst b/Doc/library/packaging.util.rst index 7513249..e628c32 100644 --- a/Doc/library/packaging.util.rst +++ b/Doc/library/packaging.util.rst @@ -90,7 +90,7 @@ This module contains various helpers for the other modules. Search the path for a given executable name. -.. function:: execute(func, args, msg=None, verbose=0, dry_run=0) +.. function:: execute(func, args, msg=None, dry_run=False) Perform some action that affects the outside world (for instance, writing to the filesystem). Such actions are special because they are disabled by the |