[Python-checkins] python/dist/src/Doc/inst inst.tex,1.41,1.42

fdrake@users.sourceforge.net fdrake@users.sourceforge.net
Thu, 31 Oct 2002 12:46:23 -0800


Update of /cvsroot/python/python/dist/src/Doc/inst
In directory usw-pr-cvs1:/tmp/cvs-serv2666

Modified Files:
	inst.tex 
Log Message:
Add a missing % to a Windows-style environment variable expression.
Minor style guide compliance fix.
Several markup fixes.


Index: inst.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/inst/inst.tex,v
retrieving revision 1.41
retrieving revision 1.42
diff -C2 -d -r1.41 -r1.42
*** inst.tex	18 Oct 2002 16:33:30 -0000	1.41
--- inst.tex	31 Oct 2002 20:46:20 -0000	1.42
***************
*** 120,124 ****
  
  If all these things are true, then you already know how to build and
! install the modules you've just downloaded: run the command above.
  Unless you need to install things in a non-standard way or customize the
  build process, you don't really need this manual.  Or rather, the above
--- 120,124 ----
  
  If all these things are true, then you already know how to build and
! install the modules you've just downloaded:  Run the command above.
  Unless you need to install things in a non-standard way or customize the
  build process, you don't really need this manual.  Or rather, the above
***************
*** 194,198 ****
  can use the setup script to do one thing at a time.  This is
  particularly helpful when the build and install will be done by
! different users---e.g., you might want to build a module distribution
  and hand it off to a system administrator for installation (or do it
  yourself, with super-user privileges).
--- 194,198 ----
  can use the setup script to do one thing at a time.  This is
  particularly helpful when the build and install will be done by
! different users---for example, you might want to build a module distribution
  and hand it off to a system administrator for installation (or do it
  yourself, with super-user privileges).
***************
*** 601,605 ****
  The specified installation directories are relative to \filevar{prefix}.
  Of course, you also have to ensure that these directories are in
! Python's module search path, e.g. by putting a \file{.pth} file in
  \filevar{prefix}.
  
--- 601,605 ----
  The specified installation directories are relative to \filevar{prefix}.
  Of course, you also have to ensure that these directories are in
! Python's module search path, such as by putting a \file{.pth} file in
  \filevar{prefix}.
  
***************
*** 721,725 ****
    {Type of file}{Location and filename}{Notes}
    \lineiii{system}{\filenq{\filevar{prefix}\textbackslash{}Lib\textbackslash{}distutils\textbackslash{}distutils.cfg}}{(4)}
!   \lineiii{personal}{\filenq{\%HOME\textbackslash{}pydistutils.cfg}}{(5)}
    \lineiii{local}{\filenq{setup.cfg}}{(3)}
  \end{tableiii}
--- 721,725 ----
    {Type of file}{Location and filename}{Notes}
    \lineiii{system}{\filenq{\filevar{prefix}\textbackslash{}Lib\textbackslash{}distutils\textbackslash{}distutils.cfg}}{(4)}
!   \lineiii{personal}{\filenq{\%HOME\%\textbackslash{}pydistutils.cfg}}{(5)}
    \lineiii{local}{\filenq{setup.cfg}}{(3)}
  \end{tableiii}
***************
*** 744,748 ****
  \item[(2)] On \UNIX, if the \envvar{HOME} environment variable is not
    defined, the user's home directory will be determined with the
!   \function{getpwuid()} function from the standard \module{pwd} module.
  \item[(3)] I.e., in the current directory (usually the location of the
    setup script).
--- 744,749 ----
  \item[(2)] On \UNIX, if the \envvar{HOME} environment variable is not
    defined, the user's home directory will be determined with the
!   \function{getpwuid()} function from the standard
!   \ulink{\module{pwd}}{../lib/module-pwd.html} module.
  \item[(3)] I.e., in the current directory (usually the location of the
    setup script).
***************
*** 861,867 ****
  module.  Lines have the following structure:
  
! \begin{verbatim}
!  <module> ... [<sourcefile> ...] [<cpparg> ...] [<library> ...]
! \end{verbatim}
  
  Let's examine each of the fields in turn.
--- 862,868 ----
  module.  Lines have the following structure:
  
! \begin{alltt}
! \var{module} ... [\var{sourcefile} ...] [\var{cpparg} ...] [\var{library} ...]
! \end{alltt}
  
  Let's examine each of the fields in turn.
***************
*** 870,887 ****
  
  \item \var{module} is the name of the extension module to be built,
! and should be a valid Python identifier.  You can't just change this
! in order to rename a module (edits to the source code would also be
! needed), so this should be left alone.
  
  \item \var{sourcefile} is anything that's likely to be a source code
! file, at least judging by the filename.  Filenames ending in .c are
! assumed to be written in C, filenames ending in .C, .cc, .c++ are
! assumed to be \Cpp, and filenames ending in .m or .mm are assumed to
! be in Objective C.
  
  \item \var{cpparg} is an argument for the C preprocessor, 
! and is anything starting with -I, -D, -U or -C .
  
! \item <library> is anything ending in .a or beginning with -l or -L.
  \end{itemize}
  
--- 871,891 ----
  
  \item \var{module} is the name of the extension module to be built,
!       and should be a valid Python identifier.  You can't just change
!       this in order to rename a module (edits to the source code would
!       also be needed), so this should be left alone.
  
  \item \var{sourcefile} is anything that's likely to be a source code
!       file, at least judging by the filename.  Filenames ending in
!       \file{.c} are assumed to be written in C, filenames ending in
!       \file{.C}, \file{.cc}, and \file{.c++} are assumed to be
!       \Cpp, and filenames ending in \file{.m} or \file{.mm} are
!       assumed to be in Objective C.
  
  \item \var{cpparg} is an argument for the C preprocessor, 
!       and is anything starting with \programopt{-I}, \programopt{-D},
!       \programopt{-U} or \programopt{-C}.
  
! \item \var{library} is anything ending in \file{.a} or beginning with
!       \programopt{-l} or \programopt{-L}.
  \end{itemize}
  
***************
*** 895,899 ****
  
  must be linked with the math library \file{libm.a} on your platform,
! simply add \samp{-lm} to the line:
  
  \begin{verbatim}
--- 899,903 ----
  
  must be linked with the math library \file{libm.a} on your platform,
! simply add \programopt{-lm} to the line:
  
  \begin{verbatim}
***************
*** 902,907 ****
  
  Arbitrary switches intended for the compiler or the linker can be
! supplied with the \code{-Xcompiler \var{arg}} and \code{-Xlinker
! \var{arg}} options:
  
  \begin{verbatim}
--- 906,911 ----
  
  Arbitrary switches intended for the compiler or the linker can be
! supplied with the \programopt{-Xcompiler} \var{arg} and
! \programopt{-Xlinker} \var{arg} options:
  
  \begin{verbatim}
***************
*** 909,919 ****
  \end{verbatim}
  
! The next option after \code{-Xcompiler} and \code{-Xlinker} will be
! appended to the proper command line, so in the above example the
! compiler will be passed the \samp{-o32} option, and the linker will be
! passed \samp{-shared}.  If a compiler option requires an argument,
! you'll have to supply multiple \code{-Xcompiler} options; for example,
! to pass \code{-x c++} the \file{Setup} file would have to contain
! \code{-Xcompiler -x -Xcompiler c++}.  
  
  Compiler flags can also be supplied through setting the
--- 913,924 ----
  \end{verbatim}
  
! The next option after \programopt{-Xcompiler} and
! \programopt{-Xlinker} will be appended to the proper command line, so
! in the above example the compiler will be passed the \programopt{-o32}
! option, and the linker will be passed \programopt{-shared}.  If a
! compiler option requires an argument, you'll have to supply multiple
! \programopt{-Xcompiler} options; for example, to pass \code{-x c++} the
! \file{Setup} file would have to contain
! \code{-Xcompiler -x -Xcompiler c++}.
  
  Compiler flags can also be supplied through setting the