diff options
author | Fred Drake <fdrake@acm.org> | 2000-04-03 20:13:55 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2000-04-03 20:13:55 (GMT) |
commit | 38e5d27caee56b6958e0034e342abb48e6100390 (patch) | |
tree | 6a0c853da853123dd2e628e8ec187517250c2530 /Doc/lib/libcompileall.tex | |
parent | 659ebfa79e891fc5e2480cd66c157970df57c451 (diff) | |
download | cpython-38e5d27caee56b6958e0034e342abb48e6100390.zip cpython-38e5d27caee56b6958e0034e342abb48e6100390.tar.gz cpython-38e5d27caee56b6958e0034e342abb48e6100390.tar.bz2 |
Merged changes from the 1.5.2p2 release.
(Very rough.)
Diffstat (limited to 'Doc/lib/libcompileall.tex')
-rw-r--r-- | Doc/lib/libcompileall.tex | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/Doc/lib/libcompileall.tex b/Doc/lib/libcompileall.tex index 64e8a9e..a731245 100644 --- a/Doc/lib/libcompileall.tex +++ b/Doc/lib/libcompileall.tex @@ -1,13 +1,9 @@ -% Documentation based on module docstrings, by Fred L. Drake, Jr. -% <fdrake@acm.org> - \section{\module{compileall} --- - Byte-compile Python libraries.} + Byte-compile Python libraries} \declaremodule{standard}{compileall} - \modulesynopsis{Tools for byte-compiling all Python source files in a -directory tree.} + directory tree.} This module provides some utility functions to support installing @@ -20,19 +16,24 @@ compile Python sources in directories named on the command line or in \code{sys.path}. -\begin{funcdesc}{compile_dir}{dir\optional{, maxlevels\optional{, ddir}}} +\begin{funcdesc}{compile_dir}{dir\optional{, maxlevels\optional{, + ddir\optional{, force}}}} Recursively descend the directory tree named by \var{dir}, compiling all \file{.py} files along the way. The \var{maxlevels} parameter is used to limit the depth of the recursion; it defaults to \code{10}. If \var{ddir} is given, it is used as the base path from - which the filenames used in error messages will be generated. + which the filenames used in error messages will be generated. If + \var{force} is true, modules are re-compiled even if the timestamps + are up to date. \end{funcdesc} -\begin{funcdesc}{compile_path}{\optional{skip_curdir\optional{, maxlevels}}} +\begin{funcdesc}{compile_path}{\optional{skip_curdir\optional{, + maxlevels\optional{, force}}}} Byte-compile all the \file{.py} files found along \code{sys.path}. - If \var{skip_curdir} is true (the default), the current directory is - not included in the search. The \var{maxlevels} parameter defaults - to \code{0} and is passed to the \function{compile_dir()} function. + If \var{skip_curdir} is true (the default), the current directory is + not included in the search. The \var{maxlevels} and + \var{force} parameters default to \code{0} and are passed to the + \function{compile_dir()} function. \end{funcdesc} |