summaryrefslogtreecommitdiffstats
path: root/Doc/distutils
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-06-09 14:28:19 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-06-09 14:28:19 (GMT)
commit577a6af8e6b715e6b46e92cf14603a266fc361a8 (patch)
tree0e8dea141496acacce19f2805a14b979a6ca74af /Doc/distutils
parentf5949b5e4709ad6986aa1be79531198868227c1d (diff)
parentebc991c0ce4493be276f2ea29676131b8880ec10 (diff)
downloadcpython-577a6af8e6b715e6b46e92cf14603a266fc361a8.zip
cpython-577a6af8e6b715e6b46e92cf14603a266fc361a8.tar.gz
cpython-577a6af8e6b715e6b46e92cf14603a266fc361a8.tar.bz2
Merge doc fixes from 3.2
Diffstat (limited to 'Doc/distutils')
-rw-r--r--Doc/distutils/install.rst15
-rw-r--r--Doc/distutils/introduction.rst10
2 files changed, 17 insertions, 8 deletions
diff --git a/Doc/distutils/install.rst b/Doc/distutils/install.rst
index 31c1d7f..f8d6305 100644
--- a/Doc/distutils/install.rst
+++ b/Doc/distutils/install.rst
@@ -96,10 +96,16 @@ in the name of the downloaded archive, e.g. :file:`foo-1.0.tar.gz` or
directory: :file:`foo-1.0` or :file:`widget-0.9.7`. Additionally, the
distribution will contain a setup script :file:`setup.py`, and a file named
:file:`README.txt` or possibly just :file:`README`, which should explain that
-building and installing the module distribution is a simple matter of running ::
+building and installing the module distribution is a simple matter of running
+one command from a terminal::
python setup.py install
+For Windows, this command should be run from a command prompt windows ("DOS
+box")::
+
+ setup.py install
+
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
@@ -113,14 +119,11 @@ Standard Build and Install
==========================
As described in section :ref:`inst-new-standard`, building and installing a module
-distribution using the Distutils is usually one simple command::
+distribution using the Distutils is usually one simple command to run from a
+terminal::
python setup.py install
-On Unix, you'd run this command from a shell prompt; on Windows, you have to
-open a command prompt window ("DOS box") and do it there; on Mac OS X, you open
-a :command:`Terminal` window to get a shell prompt.
-
.. _inst-platform-variations:
diff --git a/Doc/distutils/introduction.rst b/Doc/distutils/introduction.rst
index 8dc604d..57d34a4 100644
--- a/Doc/distutils/introduction.rst
+++ b/Doc/distutils/introduction.rst
@@ -79,11 +79,17 @@ Some observations:
for an example)
To create a source distribution for this module, you would create a setup
-script, :file:`setup.py`, containing the above code, and run::
+script, :file:`setup.py`, containing the above code, and run this command from a
+terminal::
python setup.py sdist
-which will create an archive file (e.g., tarball on Unix, ZIP file on Windows)
+For Windows, open a command prompt windows ("DOS box") and change the command
+to::
+
+ setup.py sdist
+
+:command:`sdist` will create an archive file (e.g., tarball on Unix, ZIP file on Windows)
containing your setup script :file:`setup.py`, and your module :file:`foo.py`.
The archive file will be named :file:`foo-1.0.tar.gz` (or :file:`.zip`), and
will unpack into a directory :file:`foo-1.0`.