diff options
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/install/install.rst | 2 | ||||
-rw-r--r-- | Doc/install/pysetup.rst | 2 | ||||
-rw-r--r-- | Doc/library/packaging.compiler.rst | 10 | ||||
-rw-r--r-- | Doc/library/packaging.util.rst | 11 | ||||
-rw-r--r-- | Doc/packaging/setupcfg.rst | 2 | ||||
-rw-r--r-- | Doc/whatsnew/3.3.rst | 2 |
6 files changed, 16 insertions, 13 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/install/pysetup.rst b/Doc/install/pysetup.rst index f6f1f83..d472c24 100644 --- a/Doc/install/pysetup.rst +++ b/Doc/install/pysetup.rst @@ -149,7 +149,7 @@ Getting a list of all pysetup actions and global options:: list: List installed projects graph: Display a graph create: Create a project - generate-setup: Generate a backward-comptatible setup.py + generate-setup: Generate a backward-compatible setup.py To get more help on an action, use: 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 2b3103c..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 @@ -117,7 +117,8 @@ This module contains various helpers for the other modules. :exc:`ValueError` if *val* is anything else. -.. function:: byte_compile(py_files[, optimize=0, force=0, prefix=None, base_dir=None, verbose=1, dry_run=0, direct=None]) +.. function:: byte_compile(py_files, optimize=0, force=0, prefix=None, \ + base_dir=None, dry_run=0, direct=None) Byte-compile a collection of Python source files to either :file:`.pyc` or :file:`.pyo` files in a :file:`__pycache__` subdirectory (see :pep:`3147`), @@ -131,6 +132,9 @@ This module contains various helpers for the other modules. * ``1`` - normal optimization (like ``python -O``) * ``2`` - extra optimization (like ``python -OO``) + This function is independent from the running Python's :option:`-O` or + :option:`-B` options; it is fully controlled by the parameters passed in. + If *force* is true, all files are recompiled regardless of timestamps. The source filename encoded in each :term:`bytecode` file defaults to the filenames @@ -149,6 +153,3 @@ This module contains various helpers for the other modules. figure out to use direct compilation or not (see the source for details). The *direct* flag is used by the script generated in indirect mode; unless you know what you're doing, leave it set to ``None``. - - This function is independent from the running Python's :option:`-O` or - :option:`-B` options; it is fully controlled by the parameters passed in. diff --git a/Doc/packaging/setupcfg.rst b/Doc/packaging/setupcfg.rst index 9b09a4c..a381017 100644 --- a/Doc/packaging/setupcfg.rst +++ b/Doc/packaging/setupcfg.rst @@ -779,7 +779,7 @@ needs to have its options defined in a dedicated section. Here's an example:: extra_compile_args = -fPIC -O2 -DGECODE_VERSION=$(./gecode_version) -- sys.platform != 'win32' - /DGECODE_VERSION='win32' -- sys.platform == 'win32' + /DGECODE_VERSION=win32 -- sys.platform == 'win32' The section name must start with ``extension:``; the right-hand part is used as the full name (including a parent package, if any) of the extension. Whitespace diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst index 7f4517f..7e877fc 100644 --- a/Doc/whatsnew/3.3.rst +++ b/Doc/whatsnew/3.3.rst @@ -596,7 +596,7 @@ Other issues paths. In previous versions, it did. See changeset for doc changes in various files. Contributed by Carl Meyer with editions by Éric Araujo. -.. Issue #10998: -Q command-line flags are related artifacts have been +.. Issue #10998: the -Q command-line flag and related artifacts have been removed. Code checking sys.flags.division_warning will need updating. Contributed by Éric Araujo. |