]> granicus.if.org Git - python/commitdiff
Add examples that work on Windows to distutils docs (#1626300)
authorÉric Araujo <merwok@netwok.org>
Tue, 7 Jun 2011 23:11:36 +0000 (01:11 +0200)
committerÉric Araujo <merwok@netwok.org>
Tue, 7 Jun 2011 23:11:36 +0000 (01:11 +0200)
Doc/distutils/introduction.rst
Doc/install/index.rst

index 8dc604d0d05c66ec4eb52c21a28c30b6923c7f78..57d34a4b57ea961c4a9f421da7b024c1fb0611b5 100644 (file)
@@ -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`.
index 31c1d7ff12ef24e5463407ee1e49e5062f1bfbd1..f8d63057a6c811bd8af0abadf1d39623ef85f1a6 100644 (file)
@@ -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: