[Python-checkins] python/dist/src/Doc/dist dist.tex,1.68,1.69

fdrake at users.sourceforge.net fdrake at users.sourceforge.net
Tue Mar 23 13:54:15 EST 2004


Update of /cvsroot/python/python/dist/src/Doc/dist
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2208

Modified Files:
	dist.tex 
Log Message:
- use recommended Python style in examples (no spaces around "=" for
  keyword args)
- format multi-line calls to distutils.core.setup() consistently, and
  in line with general practice (one keyword arg per line,
  comma/newline after the last
- fix a few typos


Index: dist.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/dist/dist.tex,v
retrieving revision 1.68
retrieving revision 1.69
diff -C2 -d -r1.68 -r1.69
*** dist.tex	23 Mar 2004 18:43:03 -0000	1.68
--- dist.tex	23 Mar 2004 18:54:12 -0000	1.69
***************
*** 94,100 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name="foo",
!       version="1.0",
!       py_modules=["foo"])
  \end{verbatim}
  
--- 94,101 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foo',
!       version='1.0',
!       py_modules=['foo'],
!       )
  \end{verbatim}
  
***************
*** 271,280 ****
  from distutils.core import setup
  
! setup(name="Distutils",
!       version="1.0",
!       description="Python Distribution Utilities",
!       author="Greg Ward",
!       author_email="gward at python.net",
!       url="http://www.python.org/sigs/distutils-sig/",
        packages=['distutils', 'distutils.command'],
       )
--- 272,281 ----
  from distutils.core import setup
  
! setup(name='Distutils',
!       version='1.0',
!       description='Python Distribution Utilities',
!       author='Greg Ward',
!       author_email='gward at python.net',
!       url='http://www.python.org/sigs/distutils-sig/',
        packages=['distutils', 'distutils.command'],
       )
***************
*** 410,414 ****
  
  \begin{verbatim}
! uExtension("foo", ["foo.c"])
  \end{verbatim}
  
--- 411,415 ----
  
  \begin{verbatim}
! Extension('foo', ['foo.c'])
  \end{verbatim}
  
***************
*** 420,425 ****
  \begin{verbatim}
  from distutils.core import setup, Extension
! setup(name="foo", version="1.0",
!       ext_modules=[Extension("foo", ["foo.c"])])
  \end{verbatim}
  
--- 421,428 ----
  \begin{verbatim}
  from distutils.core import setup, Extension
! setup(name='foo',
!       version='1.0',
!       ext_modules=[Extension('foo', ['foo.c'])],
!       )
  \end{verbatim}
  
***************
*** 436,440 ****
  
  \begin{verbatim}
! Extension("foo", ["src/foo1.c", "src/foo2.c"])
  \end{verbatim}
  
--- 439,443 ----
  
  \begin{verbatim}
! Extension('foo', ['src/foo1.c', 'src/foo2.c'])
  \end{verbatim}
  
***************
*** 442,446 ****
  
  \begin{verbatim}
! Extension("pkg.foo", ["src/foo1.c", "src/foo2.c"])
  \end{verbatim}
  
--- 445,449 ----
  
  \begin{verbatim}
! Extension('pkg.foo', ['src/foo1.c', 'src/foo2.c'])
  \end{verbatim}
  
***************
*** 456,462 ****
  \begin{verbatim}
  setup(...
!       ext_package="pkg",
!       ext_modules=[Extension("foo", ["foo.c"]),
!                    Extension("subpkg.bar", ["bar.c"])]
       )
  \end{verbatim}
--- 459,465 ----
  \begin{verbatim}
  setup(...
!       ext_package='pkg',
!       ext_modules=[Extension('foo', ['foo.c']),
!                    Extension('subpkg.bar', ['bar.c'])],
       )
  \end{verbatim}
***************
*** 503,507 ****
  
  \begin{verbatim}
! Extension("foo", ["foo.c"], include_dirs=["include"])
  \end{verbatim}
  
--- 506,510 ----
  
  \begin{verbatim}
! Extension('foo', ['foo.c'], include_dirs=['include'])
  \end{verbatim}
  
***************
*** 511,515 ****
  
  \begin{verbatim}
! Extension("foo", ["foo.c"], include_dirs=["/usr/include/X11"])
  \end{verbatim}
  
--- 514,518 ----
  
  \begin{verbatim}
! Extension('foo', ['foo.c'], include_dirs=['/usr/include/X11'])
  \end{verbatim}
  
***************
*** 535,545 ****
  If you must put the \file{Numerical} include directory right into your
  header search path, though, you can find that directory using the
! Distutils \module{sysconfig} module:
  
  \begin{verbatim}
  from distutils.sysconfig import get_python_inc
! incdir = os.path.join(get_python_inc(plat_specific=1), "Numerical")
  setup(...,
!       Extension(..., include_dirs=[incdir]))
  \end{verbatim}
  
--- 538,549 ----
  If you must put the \file{Numerical} include directory right into your
  header search path, though, you can find that directory using the
! Distutils \refmodule{distutils.sysconfig} module:
  
  \begin{verbatim}
  from distutils.sysconfig import get_python_inc
! incdir = os.path.join(get_python_inc(plat_specific=1), 'Numerical')
  setup(...,
!       Extension(..., include_dirs=[incdir]),
!       )
  \end{verbatim}
  
***************
*** 591,595 ****
  \begin{verbatim}
  Extension(...,
!           libraries=["gdbm", "readline"])
  \end{verbatim}
  
--- 595,599 ----
  \begin{verbatim}
  Extension(...,
!           libraries=['gdbm', 'readline'])
  \end{verbatim}
  
***************
*** 599,604 ****
  \begin{verbatim}
  Extension(...,
!           library_dirs=["/usr/X11R6/lib"],
!           libraries=["X11", "Xt"])
  \end{verbatim}
  
--- 603,608 ----
  \begin{verbatim}
  Extension(...,
!           library_dirs=['/usr/X11R6/lib'],
!           libraries=['X11', 'Xt'])
  \end{verbatim}
  
***************
*** 642,647 ****
  
  \begin{verbatim}
! setup (... 
!        scripts = ['scripts/xmlproc_parse', 'scripts/xmlproc_val']
        )
  \end{verbatim}
--- 646,651 ----
  
  \begin{verbatim}
! setup(... 
!       scripts=['scripts/xmlproc_parse', 'scripts/xmlproc_val']
        )
  \end{verbatim}
***************
*** 728,735 ****
    available from the \ulink{PyPI website}{http://www.python.org/pypi}.
  
! \item["short string"] A single line of text, not more than 200 characters.
! \item["long string"] Multiple lines of plain text in ReStructuredText
    format (see \url{http://docutils.sf.net/}).
! \item["list of strings"] See below.
  \end{description}
  
--- 732,739 ----
    available from the \ulink{PyPI website}{http://www.python.org/pypi}.
  
! \item['short string'] A single line of text, not more than 200 characters.
! \item['long string'] Multiple lines of plain text in reStructuredText
    format (see \url{http://docutils.sf.net/}).
! \item['list of strings'] See below.
  \end{description}
  
***************
*** 759,763 ****
  \begin{verbatim}
  setup(...
!       classifiers = [
            'Development Status :: 4 - Beta',
            'Environment :: Console',
--- 763,767 ----
  \begin{verbatim}
  setup(...
!       classifiers=[
            'Development Status :: 4 - Beta',
            'Environment :: Console',
***************
*** 781,785 ****
  wish to remain backwards-compatible with Python releases prior to 2.2.3,
  then you can include the following code fragment in your \file{setup.py}
! before the \code{setup()} call.
  
  \begin{verbatim}
--- 785,789 ----
  wish to remain backwards-compatible with Python releases prior to 2.2.3,
  then you can include the following code fragment in your \file{setup.py}
! before the \function{setup()} call.
  
  \begin{verbatim}
***************
*** 1045,1051 ****
  
  The meanings should be fairly clear: include all files in the
! distribution root matching \code{*.txt}, all files anywhere under the
! \file{examples} directory matching \code{*.txt} or \code{*.py}, and
! exclude all directories matching \code{examples/sample?/build}.  All of
  this is done \emph{after} the standard include set, so you can exclude
  files from the standard set with explicit instructions in the manifest
--- 1049,1055 ----
  
  The meanings should be fairly clear: include all files in the
! distribution root matching \file{*.txt}, all files anywhere under the
! \file{examples} directory matching \file{*.txt} or \file{*.py}, and
! exclude all directories matching \file{examples/sample?/build}.  All of
  this is done \emph{after} the standard include set, so you can exclude
  files from the standard set with explicit instructions in the manifest
***************
*** 1308,1312 ****
  
  \begin{verbatim}
! python setup.py bdist_rpm --packager="John Doe <jdoe at python.net>" \
                  bdist_wininst --target_version="2.0"
  \end{verbatim}
--- 1312,1316 ----
  
  \begin{verbatim}
! python setup.py bdist_rpm --packager="John Doe <jdoe at example.org>" \
                  bdist_wininst --target_version="2.0"
  \end{verbatim}
***************
*** 1609,1614 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foo", version = "1.0",
!       py_modules = ["foo"])
  \end{verbatim}
  Note that the name of the distribution is specified independently with
--- 1613,1620 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foo',
!       version='1.0',
!       py_modules=['foo'],
!       )
  \end{verbatim}
  Note that the name of the distribution is specified independently with
***************
*** 1631,1636 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       py_modules = ["foo", "bar"])
  \end{verbatim}
  
--- 1637,1644 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       py_modules=['foo', 'bar'],
!       )
  \end{verbatim}
  
***************
*** 1654,1659 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       packages = [""])
  \end{verbatim}
  (The empty string stands for the root package.)
--- 1662,1669 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       packages=[''],
!       )
  \end{verbatim}
  (The empty string stands for the root package.)
***************
*** 1671,1677 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       package_dir = {"": "src"},
!       packages = [""])
  \end{verbatim}
  
--- 1681,1689 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       package_dir={'': 'src'},
!       packages=[''],
!       )
  \end{verbatim}
  
***************
*** 1692,1697 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       packages = ["foobar"])
  \end{verbatim}
  
--- 1704,1711 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       packages=['foobar'],
!       )
  \end{verbatim}
  
***************
*** 1711,1717 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       package_dir = {"foobar" : "src"},
!       packages = ["foobar"])
  \end{verbatim}
  
--- 1725,1733 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       package_dir={'foobar': 'src'},
!       packages=['foobar'],
!       )
  \end{verbatim}
  
***************
*** 1728,1734 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       package_dir = {"foobar" : ""},
!       packages = ["foobar"])
  \end{verbatim}
  (The empty string also stands for the current directory.)
--- 1744,1752 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       package_dir={'foobar': ''},
!       packages=['foobar'],
!       )
  \end{verbatim}
  (The empty string also stands for the current directory.)
***************
*** 1755,1760 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       packages = ["foobar", "foobar.subfoo"])
  \end{verbatim}
  (Again, the empty string in \option{package\_dir} stands for the current
--- 1773,1780 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       packages=['foobar', 'foobar.subfoo'],
!       )
  \end{verbatim}
  (Again, the empty string in \option{package\_dir} stands for the current
***************
*** 1778,1783 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       ext_modules = [Extension("foo", ["foo.c"])])
  \end{verbatim}
  
--- 1798,1805 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       ext_modules=[Extension('foo', ['foo.c'])],
!       )
  \end{verbatim}
  
***************
*** 1790,1795 ****
  \begin{verbatim}
  from distutils.core import setup
! setup(name = "foobar", version = "1.0",
!       ext_modules = [Extension("foopkg.foo", ["foo.c"])])
  \end{verbatim}
  
--- 1812,1819 ----
  \begin{verbatim}
  from distutils.core import setup
! setup(name='foobar',
!       version='1.0',
!       ext_modules=[Extension('foopkg.foo', ['foo.c'])],
!       )
  \end{verbatim}
  




More information about the Python-checkins mailing list