summaryrefslogtreecommitdiffstats
path: root/Doc/distutils
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2012-02-05 12:49:59 (GMT)
committerÉric Araujo <merwok@netwok.org>2012-02-05 12:49:59 (GMT)
commitcd0d951a707c0dbecfd45c14b0e6ec7bf83103a2 (patch)
tree3e40b36621bfc2f4140b612d8a6d2ed01d1f9e39 /Doc/distutils
parentbe095b3b9857a5b949dd23b89dac5f5151b252d5 (diff)
parentcd2a6033ac0bafd69a7cba2d132e092127acc895 (diff)
downloadcpython-cd0d951a707c0dbecfd45c14b0e6ec7bf83103a2.zip
cpython-cd0d951a707c0dbecfd45c14b0e6ec7bf83103a2.tar.gz
cpython-cd0d951a707c0dbecfd45c14b0e6ec7bf83103a2.tar.bz2
Merge edits from 3.2 (#13716, #1040439, #2945, #13770, #6715)
Diffstat (limited to 'Doc/distutils')
-rw-r--r--Doc/distutils/apiref.rst36
1 files changed, 11 insertions, 25 deletions
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index 97f1bed..71702e5 100644
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -449,7 +449,9 @@ This module provides the following functions.
Define a preprocessor macro for all compilations driven by this compiler object.
The optional parameter *value* should be a string; if it is not supplied, then
the macro will be defined without an explicit value and the exact outcome
- depends on the compiler used (XXX true? does ANSI say anything about this?)
+ depends on the compiler used.
+
+ .. XXX true? does ANSI say anything about this?
.. method:: CCompiler.undefine_macro(name)
@@ -603,7 +605,9 @@ This module provides the following functions.
*output_libname* should be a library name, not a filename; the filename will be
inferred from the library name. *output_dir* is the directory where the library
- file will be put. XXX defaults to what?
+ file will be put.
+
+ .. XXX defaults to what?
*debug* is a boolean; if true, debugging information will be included in the
library (note that on most platforms, it is the compile step where this matters:
@@ -723,30 +727,29 @@ This module provides the following functions.
Invokes :func:`distutils.util.execute` This method invokes a Python function
*func* with the given arguments *args*, after logging and taking into account
- the *dry_run* flag. XXX see also.
+ the *dry_run* flag.
.. method:: CCompiler.spawn(cmd)
Invokes :func:`distutils.util.spawn`. This invokes an external process to run
- the given command. XXX see also.
+ the given command.
.. method:: CCompiler.mkpath(name[, mode=511])
Invokes :func:`distutils.dir_util.mkpath`. This creates a directory and any
- missing ancestor directories. XXX see also.
+ missing ancestor directories.
.. method:: CCompiler.move_file(src, dst)
- Invokes :meth:`distutils.file_util.move_file`. Renames *src* to *dst*. XXX see
- also.
+ Invokes :meth:`distutils.file_util.move_file`. Renames *src* to *dst*.
.. method:: CCompiler.announce(msg[, level=1])
- Write a message using :func:`distutils.log.debug`. XXX see also.
+ Write a message using :func:`distutils.log.debug`.
.. method:: CCompiler.warn(msg)
@@ -874,8 +877,6 @@ tarballs or zipfiles.
prefix of all files and directories in the archive. *root_dir* and *base_dir*
both default to the current directory. Returns the name of the archive file.
- .. XXX This should be changed to support bz2 files.
-
.. function:: make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0])
@@ -887,8 +888,6 @@ tarballs or zipfiles.
possibly plus the appropriate compression extension (:file:`.gz`, :file:`.bz2`
or :file:`.Z`). Return the output filename.
- .. XXX This should be replaced with calls to the :mod:`tarfile` module.
-
.. function:: make_zipfile(base_name, base_dir[, verbose=0, dry_run=0])
@@ -1000,8 +999,6 @@ directories.
errors are ignored (apart from being reported to ``sys.stdout`` if *verbose* is
true).
-.. XXX Some of this could be replaced with the shutil module?
-
:mod:`distutils.file_util` --- Single file operations
=====================================================
@@ -1115,8 +1112,6 @@ other utility module.
* ``macosx-10.6-intel``
- .. % XXX isn't this also provided by some other non-distutils module?
-
.. function:: convert_path(pathname)
@@ -1320,8 +1315,6 @@ provides the following additional features:
the "negative alias" of :option:`--verbose`, then :option:`--quiet` on the
command line sets *verbose* to false.
-.. XXX Should be replaced with optparse
-
.. function:: fancy_getopt(options, negative_opt, object, args)
Wrapper function. *options* is a list of ``(long_option, short_option,
@@ -1337,9 +1330,6 @@ provides the following additional features:
Wraps *text* to less than *width* wide.
- .. XXX Should be replaced with :mod:`textwrap` (which is available in Python
- 2.3 and later).
-
.. class:: FancyGetopt([option_table=None])
@@ -1402,10 +1392,6 @@ filesystem and building lists of files.
:synopsis: A simple logging mechanism, 282-style
-.. XXX Should be replaced with standard :mod:`logging` module.
-
-
-
:mod:`distutils.spawn` --- Spawn a sub-process
==============================================