[Python-checkins] python/dist/src/Doc/dist dist.tex,1.65,1.66
fdrake at users.sourceforge.net
fdrake at users.sourceforge.net
Thu Feb 19 18:17:50 EST 2004
Update of /cvsroot/python/python/dist/src/Doc/dist
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26615
Modified Files:
dist.tex
Log Message:
- "Mac OS" should always include the space
- comment out documentation for a non-existant feature (--spec-file)
that the comments indicate isn't clearly needed
- lots of minor markup adjustments to get a more consistent
presentation
Index: dist.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/dist/dist.tex,v
retrieving revision 1.65
retrieving revision 1.66
diff -C2 -d -r1.65 -r1.66
*** dist.tex 19 Feb 2004 23:03:29 -0000 1.65
--- dist.tex 19 Feb 2004 23:17:46 -0000 1.66
***************
*** 296,302 ****
setup script portable across operating systems, which of course is one
of the major goals of the Distutils. In this spirit, all pathnames in
! this document are slash-separated. (MacOS programmers should keep in
mind that the \emph{absence} of a leading slash indicates a relative
! path, the opposite of the MacOS convention with colons.)
This, of course, only applies to pathnames given to Distutils
--- 296,302 ----
setup script portable across operating systems, which of course is one
of the major goals of the Distutils. In this spirit, all pathnames in
! this document are slash-separated. (Mac OS programmers should keep in
mind that the \emph{absence} of a leading slash indicates a relative
! path, the opposite of the Mac OS convention with colons.)
This, of course, only applies to pathnames given to Distutils
***************
*** 965,969 ****
default format for the current platform. The default format is a gzip'ed
tar file (\file{.tar.gz}) on \UNIX, and ZIP file on Windows.
! \XXX{no MacOS support here}
You can specify as many formats as you like using the
--- 965,969 ----
default format for the current platform. The default format is a gzip'ed
tar file (\file{.tar.gz}) on \UNIX, and ZIP file on Windows.
! \XXX{no Mac OS support here}
You can specify as many formats as you like using the
***************
*** 975,978 ****
--- 975,979 ----
to create a gzipped tarball and a zip file. The available formats are:
+
\begin{tableiii}{l|l|c}{code}%
{Format}{Description}{Notes}
***************
*** 1008,1012 ****
\item all C source files mentioned in the \option{ext\_modules} or
\option{libraries} options (\XXX{getting C library sources currently
! broken -- no get\_source\_files() method in build\_clib.py!})
\item anything that looks like a test script: \file{test/test*.py}
(currently, the Distutils don't do anything with test scripts except
--- 1009,1013 ----
\item all C source files mentioned in the \option{ext\_modules} or
\option{libraries} options (\XXX{getting C library sources currently
! broken---no \method{get_source_files()} method in \file{build_clib.py}!})
\item anything that looks like a test script: \file{test/test*.py}
(currently, the Distutils don't do anything with test scripts except
***************
*** 1220,1223 ****
--- 1221,1225 ----
The available formats for built distributions are:
+
\begin{tableiii}{l|l|c}{code}%
{Format}{Description}{Notes}
***************
*** 1256,1259 ****
--- 1258,1262 ----
RPMs. The \command{bdist} sub-commands, and the formats generated by
each, are:
+
\begin{tableii}{l|l}{command}%
{Command}{Formats}
***************
*** 1315,1318 ****
--- 1318,1322 ----
sections in the \file{.spec} file are derived from options in the setup
script as follows:
+
\begin{tableii}{l|l}{textrm}%
{RPM \file{.spec} file option or section}{Distutils setup script option}
***************
*** 1330,1333 ****
--- 1334,1338 ----
corresponding options in the setup script. Most of these are handled
through options to the \command{bdist\_rpm} command as follows:
+
\begin{tableiii}{l|l|l}{textrm}%
{RPM \file{.spec} file option or section}%
***************
*** 1346,1349 ****
--- 1351,1355 ----
\lineiii{Icon}{\option{icon}}{(none)}
\end{tableiii}
+
Obviously, supplying even a few of these options on the command-line
would be tedious and error-prone, so it's usually best to put them in
***************
*** 1356,1359 ****
--- 1362,1366 ----
There are three steps to building a binary RPM package, all of which are
handled automatically by the Distutils:
+
\begin{enumerate}
\item create a \file{.spec} file, which describes the package (analogous
***************
*** 1365,1394 ****
extensions)
\end{enumerate}
Normally, RPM bundles the last two steps together; when you use the
Distutils, all three steps are typically bundled together.
If you wish, you can separate these three steps. You can use the
! \longprogramopt{spec-only} option to make \command{bdist\_rpm} just
create the \file{.spec} file and exit; in this case, the \file{.spec}
file will be written to the ``distribution directory''---normally
\file{dist/}, but customizable with the \longprogramopt{dist-dir}
option. (Normally, the \file{.spec} file winds up deep in the ``build
! tree,'' in a temporary directory created by \command{bdist\_rpm}.)
!
! \XXX{this isn't implemented yet---is it needed?!}
! You can also specify a custom \file{.spec} file with the
! \longprogramopt{spec-file} option; used in conjunction with
! \longprogramopt{spec-only}, this gives you an opportunity to customize
! the \file{.spec} file manually:
!
! \begin{verbatim}
! > python setup.py bdist_rpm --spec-only
! # ...edit dist/FooBar-1.0.spec
! > python setup.py bdist_rpm --spec-file=dist/FooBar-1.0.spec
! \end{verbatim}
! (Although a better way to do this is probably to override the standard
! \command{bdist\_rpm} command with one that writes whatever else you want
! to the \file{.spec} file.)
--- 1372,1402 ----
extensions)
\end{enumerate}
+
Normally, RPM bundles the last two steps together; when you use the
Distutils, all three steps are typically bundled together.
If you wish, you can separate these three steps. You can use the
! \longprogramopt{spec-only} option to make \command{bdist_rpm} just
create the \file{.spec} file and exit; in this case, the \file{.spec}
file will be written to the ``distribution directory''---normally
\file{dist/}, but customizable with the \longprogramopt{dist-dir}
option. (Normally, the \file{.spec} file winds up deep in the ``build
! tree,'' in a temporary directory created by \command{bdist_rpm}.)
! % \XXX{this isn't implemented yet---is it needed?!}
! % You can also specify a custom \file{.spec} file with the
! % \longprogramopt{spec-file} option; used in conjunction with
! % \longprogramopt{spec-only}, this gives you an opportunity to customize
! % the \file{.spec} file manually:
! %
! % \begin{verbatim}
! % > python setup.py bdist_rpm --spec-only
! % # ...edit dist/FooBar-1.0.spec
! % > python setup.py bdist_rpm --spec-file=dist/FooBar-1.0.spec
! % \end{verbatim}
! %
! % (Although a better way to do this is probably to override the standard
! % \command{bdist\_rpm} command with one that writes whatever else you want
! % to the \file{.spec} file.)
***************
*** 1860,1863 ****
--- 1868,1872 ----
The manifest template commands are:
+
\begin{tableii}{ll}{command}{Command}{Description}
\lineii{include \var{pat1} \var{pat2} ... }
***************
*** 1878,1881 ****
--- 1887,1891 ----
\lineii{graft \var{dir}}{include all files under \var{dir}}
\end{tableii}
+
The patterns here are \UNIX-style ``glob'' patterns: \code{*} matches any
sequence of regular filename characters, \code{?} matches any single
***************
*** 1884,1890 ****
\code{a-f0-9\_.}). The definition of ``regular filename character'' is
platform-specific: on \UNIX{} it is anything except slash; on Windows
! anything except backslash or colon; on MacOS anything except colon.
! \XXX{Windows and MacOS support not there yet}
--- 1894,1900 ----
\code{a-f0-9\_.}). The definition of ``regular filename character'' is
platform-specific: on \UNIX{} it is anything except slash; on Windows
! anything except backslash or colon; on Mac OS anything except colon.
! \XXX{Windows and Mac OS support not there yet}
More information about the Python-checkins
mailing list