Skip to content

Commit ce0e3bd

Browse files
freddrakefreddrake
committed
correct several markup errors caught by the GNU info conversion
1 parent 512a4dc commit ce0e3bd

1 file changed

Lines changed: 25 additions & 22 deletions

File tree

‎Doc/dist/dist.tex‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2134,9 +2134,9 @@ \section{\module{distutils.core} --- Core Distutils functionality}
21342134
the contents of the config files or command-line.
21352135

21362136
\var{script_name} is a file that will be run with \function{execfile()}
2137-
\var{sys.argv[0]} will be replaced with \var{script} for the duration of the
2137+
\code{sys.argv[0]} will be replaced with \var{script} for the duration of the
21382138
call. \var{script_args} is a list of strings; if supplied,
2139-
\var{sys.argv[1:]} will be replaced by \var{script_args} for the duration
2139+
\code{sys.argv[1:]} will be replaced by \var{script_args} for the duration
21402140
of the call.
21412141

21422142
\var{stop_after} tells \function{setup()} when to stop processing; possible
@@ -2257,22 +2257,24 @@ \section{\module{distutils.ccompiler} --- CCompiler base class}
22572257
\end{funcdesc}
22582258

22592259
\begin{funcdesc}{gen_preprocess_options}{macros, include_dirs}
2260-
Generate C pre-processor options (-D, -U, -I) as used by at least
2260+
Generate C pre-processor options (\programopt{-D}, \programopt{-U},
2261+
\programopt{-I}) as used by at least
22612262
two types of compilers: the typical \UNIX{} compiler and Visual \Cpp.
2262-
\var{macros} is the usual thing, a list of 1- or 2-tuples, where \var{(name,)}
2263-
means undefine (-U) macro \var{name}, and \var{(name,value)} means define (-D)
2264-
macro \var{name} to \var{value}. \var{include_dirs} is just a list of directory
2265-
names to be added to the header file search path (-I). Returns a list
2266-
of command-line options suitable for either \UNIX{} compilers or Visual
2267-
\Cpp.
2263+
\var{macros} is the usual thing, a list of 1- or 2-tuples, where
2264+
\code{(\var{name},)} means undefine (\programopt{-U}) macro \var{name},
2265+
and \code{(\var{name}, \var{value})} means define (\programopt{-D})
2266+
macro \var{name} to \var{value}. \var{include_dirs} is just a list of
2267+
directory names to be added to the header file search path (\programopt{-I}).
2268+
Returns a list of command-line options suitable for either \UNIX{} compilers
2269+
or Visual \Cpp.
22682270
\end{funcdesc}
22692271

22702272
\begin{funcdesc}{get_default_compiler}{osname, platform}
22712273
Determine the default compiler to use for the given platform.
22722274

2273-
\var{osname} should be one of the standard Python OS names (i.e. the
2274-
ones returned by \var{os.name}) and \var{platform} the common value
2275-
returned by \var{sys.platform} for the platform in question.
2275+
\var{osname} should be one of the standard Python OS names (i.e.\ the
2276+
ones returned by \code{os.name}) and \var{platform} the common value
2277+
returned by \code{sys.platform} for the platform in question.
22762278

22772279
The default values are \code{os.name} and \code{sys.platform} in case the
22782280
parameters are not given.
@@ -2504,7 +2506,8 @@ \section{\module{distutils.ccompiler} --- CCompiler base class}
25042506
\file{build/foo/bar.o}.
25052507

25062508
\var{macros}, if given, must be a list of macro definitions. A macro
2507-
definition is either a \var{(name, value)} 2-tuple or a \var{(name,)} 1-tuple.
2509+
definition is either a \code{(\var{name}, \var{value})} 2-tuple or a
2510+
\code{(\var{name},)} 1-tuple.
25082511
The former defines a macro; if the value is \code{None}, the macro is
25092512
defined without an explicit value. The 1-tuple case undefines a
25102513
macro. Later definitions/redefinitions/undefinitions take
@@ -2517,7 +2520,7 @@ \section{\module{distutils.ccompiler} --- CCompiler base class}
25172520
\var{debug} is a boolean; if true, the compiler will be instructed to
25182521
output debug symbols in (or alongside) the object file(s).
25192522

2520-
\var{extra_preargs} and \var{extra_postargs} are implementation- dependent.
2523+
\var{extra_preargs} and \var{extra_postargs} are implementation-dependent.
25212524
On platforms that have the notion of a command-line (e.g. \UNIX,
25222525
DOS/Windows), they are most likely lists of strings: extra
25232526
command-line arguments to prepend/append to the compiler command
@@ -2791,8 +2794,8 @@ \section{\module{distutils.archive_util} ---
27912794
\end{funcdesc}
27922795

27932796
\begin{funcdesc}{make_tarball}{base_name, base_dir\optional{, compress=\code{'gzip'}, verbose=\code{0}, dry_run=\code{0}}}'Create an (optional compressed) archive as a tar file from all files in and under \var{base_dir}. \var{compress} must be \code{'gzip'} (the default),
2794-
\code{'compress'}, \code{'bzip2'}, or \code{None}. Both \code{'tar'}
2795-
and the compression utility named by \var{'compress'} must be on the
2797+
\code{'compress'}, \code{'bzip2'}, or \code{None}. Both \program{tar}
2798+
and the compression utility named by \var{compress} must be on the
27962799
default program search path, so this is probably \UNIX-specific. The
27972800
output tar file will be named \file{\var{base_dir}.tar}, possibly plus
27982801
the appropriate compression extension (\file{.gz}, \file{.bz2} or
@@ -2881,7 +2884,7 @@ \section{\module{distutils.dir_util} --- Directory tree operations}
28812884
Copy an entire directory tree \var{src} to a new location \var{dst}. Both
28822885
\var{src} and \var{dst} must be directory names. If \var{src} is not a
28832886
directory, raise \exception{DistutilsFileError}. If \var{dst} does
2884-
not exist, it is created with \var{mkpath()}. The end result of the
2887+
not exist, it is created with \function{mkpath()}. The end result of the
28852888
copy is that every file in \var{src} is copied to \var{dst}, and
28862889
directories under \var{src} are recursively copied to \var{dst}.
28872890
Return the list of files that were copied or might have been copied,
@@ -2901,7 +2904,7 @@ \section{\module{distutils.dir_util} --- Directory tree operations}
29012904

29022905
\begin{funcdesc}{remove_tree}{directory\optional{verbose=\code{0}, dry_run=\code{0}}}
29032906
Recursively remove \var{directory} and all files and directories underneath
2904-
it. Any errors are ignored (apart from being reported to \code{stdout} if
2907+
it. Any errors are ignored (apart from being reported to \code{sys.stdout} if
29052908
\var{verbose} is true).
29062909
\end{funcdesc}
29072910

@@ -2929,7 +2932,7 @@ \section{\module{distutils.file_util} --- Single file operations}
29292932
to \code{'hard'} or \code{'sym'}; if it is \code{None} (the default),
29302933
files are copied. Don't set \var{link} on systems that don't support
29312934
it: \function{copy_file()} doesn't check if hard or symbolic linking is
2932-
available. It uses \var{_copy_file_contents()} to copy file contents.
2935+
available. It uses \function{_copy_file_contents()} to copy file contents.
29332936

29342937
Return a tuple \samp{(dest_name, copied)}: \var{dest_name} is the actual
29352938
name of the output file, and \var{copied} is true if the file was copied
@@ -3294,11 +3297,11 @@ \section{\module{distutils.text_file} --- The TextFile class}
32943297
something that provides \method{readline()} and \method{close()}
32953298
methods). It is recommended that you supply at least \var{filename},
32963299
so that \class{TextFile} can include it in warning messages. If
3297-
\var{file} is not supplied, TextFile creates its own using the
3298-
\var{open()} builtin.
3300+
\var{file} is not supplied, \class{TextFile} creates its own using the
3301+
\function{open()} built-in function.
32993302

33003303
The options are all boolean, and affect the values returned by
3301-
\var{readline()}
3304+
\method{readline()}
33023305

33033306
\begin{tableiii}{c|l|l}{option name}{option name}{description}{default}
33043307
\lineiii{strip_comments}{

0 commit comments

Comments
 (0)