Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit eff9a87

Browse files
committed
Lots of small markup adjustments for consistency with the rest of the
documentation.
1 parent 35f8d46 commit eff9a87

2 files changed

Lines changed: 72 additions & 70 deletions

File tree

Doc/dist/dist.tex

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ \subsection{A simple example}
116116
\begin{verbatim}
117117
python setup.py sdist
118118
\end{verbatim}
119-
which will create an archive file (e.g., tarball on Unix, zip file on
119+
which will create an archive file (e.g., tarball on \UNIX, ZIP file on
120120
Windows) containing your setup script, \file{setup.py}, and your module,
121121
\file{foo.py}. The archive file will be named \file{Foo-1.0.tar.gz} (or
122122
\file{.zip}), and will unpack into a directory \file{Foo-1.0}.
@@ -194,12 +194,12 @@ \subsection{General Python terminology}
194194
single \file{.py} file (and possibly associated \file{.pyc} and/or
195195
\file{.pyo} files). Sometimes referred to as a ``pure module.''
196196
\item[extension module] a module written in the low-level language of
197-
the Python implemention: C/C++ for CPython, Java for JPython.
197+
the Python implemention: C/C++ for Python, Java for JPython.
198198
Typically contained in a single dynamically loadable pre-compiled
199-
file, e.g. a shared object (\file{.so}) file for CPython extensions on
200-
Unix, a DLL (given the \file{.pyd} extension) for CPython extensions
199+
file, e.g. a shared object (\file{.so}) file for Python extensions on
200+
\UNIX, a DLL (given the \file{.pyd} extension) for Python extensions
201201
on Windows, or a Java class file for JPython extensions. (Note that
202-
currently, the Distutils only handles C/C++ extensions for CPython.)
202+
currently, the Distutils only handles C/C++ extensions for Python.)
203203
\item[package] a module that contains other modules; typically contained
204204
in a directory in the filesystem and distinguished from other
205205
directories by the presence of a file \file{\_\_init\_\_.py}.
@@ -282,15 +282,15 @@ \section{Writing the Setup Script}
282282
maintain.
283283

284284
Note that any pathnames (files or directories) supplied in the setup
285-
script should be written using the Unix convention, i.e.
285+
script should be written using the \UNIX{} convention, i.e.
286286
slash-separated. The Distutils will take care of converting this
287287
platform-neutral representation into whatever is appropriate on your
288288
current platform before actually using the pathname. This makes your
289289
setup script portable across operating systems, which of course is one
290290
of the major goals of the Distutils. In this spirit, all pathnames in
291-
this document are slash-separated (Mac OS programmers should keep in
291+
this document are slash-separated (MacOS programmers should keep in
292292
mind that the \emph{absence} of a leading slash indicates a relative
293-
path, the opposite of the Mac OS convention with colons).
293+
path, the opposite of the MacOS convention with colons).
294294

295295

296296
\subsection{Listing whole packages}
@@ -436,7 +436,7 @@ \subsubsection{Extension source files}
436436
source files. Since the Distutils currently only support C/C++
437437
extensions, these are normally C/C++ source files. (Be sure to use
438438
appropriate extensions to distinguish C++ source files: \file{.cc} and
439-
\file{.cpp} seem to be recognized by both Unix and Windows compilers.)
439+
\file{.cpp} seem to be recognized by both \UNIX{} and Windows compilers.)
440440

441441
However, you can also include SWIG interface (\file{.i}) files in the
442442
list; the \command{build\_ext} command knows how to deal with SWIG
@@ -468,7 +468,7 @@ \subsubsection{Preprocessor options}
468468
\end{verbatim}
469469

470470
You can specify absolute directories there; if you know that your
471-
extension will only be built on Unix systems with X11R6 installed to
471+
extension will only be built on \UNIX{} systems with X11R6 installed to
472472
\file{/usr}, you can get away with
473473
\begin{verbatim}
474474
Extension("foo", ["foo.c"], include_dirs=["/usr/include/X11"])
@@ -480,7 +480,7 @@ \subsubsection{Preprocessor options}
480480
If you need to include header files from some other Python extension,
481481
you can take advantage of the fact that the Distutils install extension
482482
header files in a consistent way. For example, the Numerical Python
483-
header files are installed (on a standard Unix installation) to
483+
header files are installed (on a standard \UNIX{} installation) to
484484
\file{/usr/local/include/python1.5/Numerical}. (The exact location will
485485
differ according to your platform and Python installation.) Since the
486486
Python include directory---\file{/usr/local/include/python1.5} in this
@@ -634,7 +634,7 @@ \section{Writing the Setup Configuration File}
634634

635635
For example, say you want your extensions to be built
636636
``in-place''---that is, you have an extension \module{pkg.ext}, and you
637-
want the compiled extension file (\file{ext.so} on Unix, say) to be put
637+
want the compiled extension file (\file{ext.so} on \UNIX, say) to be put
638638
in the same source directory as your pure Python modules
639639
\module{pkg.mod1} and \module{pkg.mod2}. You can always use the
640640
\longprogramopt{inplace} option on the command-line to ensure this:
@@ -694,8 +694,8 @@ \section{Creating a Source Distribution}
694694
(assuming you haven't specified any \command{sdist} options in the setup
695695
script or config file), \command{sdist} creates the archive of the
696696
default format for the current platform. The default format is gzip'ed
697-
tar file (\file{.tar.gz}) on Unix, and ZIP file on Windows. \XXX{no Mac
698-
OS support here}
697+
tar file (\file{.tar.gz}) on \UNIX, and ZIP file on Windows.
698+
\XXX{no MacOS support here}
699699

700700
You can specify as many formats as you like using the
701701
\longprogramopt{formats} option, for example:
@@ -715,7 +715,7 @@ \section{Creating a Source Distribution}
715715
\noindent Notes:
716716
\begin{description}
717717
\item[(1)] default on Windows
718-
\item[(2)] default on Unix
718+
\item[(2)] default on \UNIX
719719
\item[(3)] requires either external \program{zip} utility or
720720
\module{zipfile} module (not part of the standard Python library)
721721
\item[(4)] requires external utilities: \program{tar} and possibly one
@@ -911,11 +911,11 @@ \section{Creating Built Distributions}
911911
in this case), does a ``fake'' installation (also in the \file{build}
912912
directory), and creates the default type of built distribution for my
913913
platform. The default format for built distributions is a ``dumb'' tar
914-
file on Unix, and an simple executable installer on Windows. (That tar
914+
file on \UNIX, and an simple executable installer on Windows. (That tar
915915
file is considered ``dumb'' because it has to be unpacked in a specific
916916
location to work.)
917917

918-
Thus, the above command on a Unix system creates
918+
Thus, the above command on a \UNIX{} system creates
919919
\file{Distutils-0.9.1.\filevar{plat}.tar.gz}; unpacking this tarball
920920
from the right place installs the Distutils just as though you had
921921
downloaded the source distribution and run \code{python setup.py
@@ -937,7 +937,7 @@ \section{Creating Built Distributions}
937937
\begin{verbatim}
938938
python setup.py bdist --format=zip
939939
\end{verbatim}
940-
would, when run on a Unix system, create
940+
would, when run on a \UNIX{} system, create
941941
\file{Distutils-0.8.\filevar{plat}.zip}---again, this archive would be
942942
unpacked from the root directory to install the Distutils.
943943

@@ -956,7 +956,7 @@ \section{Creating Built Distributions}
956956

957957
\noindent Notes:
958958
\begin{description}
959-
\item[(1)] default on Unix
959+
\item[(1)] default on \UNIX
960960
\item[(2)] default on Windows \XXX{to-do!}
961961
\item[(3)] requires external utilities: \program{tar} and possibly one
962962
of \program{gzip}, \program{bzip2}, or \program{compress}
@@ -1195,7 +1195,8 @@ \subsection{Cleaning up: the \protect\command{clean} command}
11951195
\label{clean-cmd}
11961196

11971197

1198-
\subsection{Creating a source distribution: the \protect\command{sdist} command}
1198+
\subsection{Creating a source distribution: the
1199+
\protect\command{sdist} command}
11991200
\label{sdist-cmd}
12001201

12011202

@@ -1220,15 +1221,15 @@ \subsection{Creating a source distribution: the \protect\command{sdist} command}
12201221
\lineii{prune \var{dir}}{exclude all files under \var{dir}}
12211222
\lineii{graft \var{dir}}{include all files under \var{dir}}
12221223
\end{tableii}
1223-
The patterns here are Unix-style ``glob'' patterns: \code{*} matches any
1224+
The patterns here are \UNIX-style ``glob'' patterns: \code{*} matches any
12241225
sequence of regular filename characters, \code{?} matches any single
12251226
regular filename character, and \code{[\var{range}]} matches any of the
12261227
characters in \var{range} (e.g., \code{a-z}, \code{a-zA-Z},
12271228
\code{a-f0-9\_.}). The definition of ``regular filename character'' is
1228-
platform-specific: on Unix it is anything except slash; on Windows
1229-
anything except backslash or colon; on Mac OS anything except colon.
1229+
platform-specific: on \UNIX{} it is anything except slash; on Windows
1230+
anything except backslash or colon; on MacOS anything except colon.
12301231

1231-
\XXX{Windows and Mac OS support not there yet}
1232+
\XXX{Windows and MacOS support not there yet}
12321233

12331234

12341235
\subsection{Creating a ``built'' distribution: the

0 commit comments

Comments
 (0)