1. pkumar
  2. packaging_cpython

Commits

guillermooo  committed 037b0b8

installpackages.rst (packaging): Revised for readability.

  • Participants
  • Parent commits b73f6e0
  • Branches default

Comments (0)

Files changed (1)

File Doc/packaging/enduser/installpackages.rst

View file
  • Ignore whitespace
 
 .. _packaging-config-files:
 
-Packaging configuration files
-=============================
+Configuration files for Packaging
+=================================
 
-As mentioned above, you can use Packaging configuration files to record personal
-or site preferences for any Packaging options. That is, any option to any
-command can be stored in one of two or three (depending on your platform)
-configuration files, which will be consulted before the command-line is parsed.
-This means that configuration files will override default values, and the
-command-line will in turn override configuration files. Furthermore, if
-multiple configuration files apply, values from "earlier" files are overridden
-by "later" files.
+As mentioned above, you can use configuration files to store personal or site
+preferences for any option supported by any Packaging command. Depending on your
+platform, you can use one of two or three possible configuration files. These
+files will be read before parsing the command-line, so they take precedence over
+default values. In turn, the command-line will override configuration files.
+Lastly, if there are multiple configuration files, values from files read
+earlier will be overridden by values from files read later.
+
+.. XXX "one of two or three possible..." seems wrong info. Below always 3 files
+.. are indicated in the tables.
 
 
 .. _packaging-config-filenames:
 Location and names of config files
 ----------------------------------
 
-The names and locations of the configuration files vary slightly across
-platforms. On Unix and Mac OS X, the three configuration files (in the order
-they are processed) are:
+The name and location of the configuration files vary slightly across
+platforms. On Unix and Mac OS X, these are the three configuration files listed
+in the order they are processed:
 
 +--------------+----------------------------------------------------------+-------+
 | Type of file | Location and filename                                    | Notes |
 | local        | :file:`packaging.cfg`                                    | \(3)  |
 +--------------+----------------------------------------------------------+-------+
 
-And on Windows, the configuration files are:
+Similarly, the configuration files on Windows ---also listed in the order they
+are processed--- are these:
 
 +--------------+-------------------------------------------------+-------+
 | Type of file | Location and filename                           | Notes |
 | local        | :file:`packaging.cfg`                           | \(3)  |
 +--------------+-------------------------------------------------+-------+
 
-On all platforms, the "personal" file can be temporarily disabled by
-passing the `--no-user-cfg` option.
+On all platforms, the *personal* file can be temporarily disabled by
+means of the `--no-user-cfg` option.
 
 Notes:
 
 (2)
    On Unix, if the :envvar:`HOME` environment variable is not defined, the
    user's home directory will be determined with the :func:`getpwuid` function
-   from the standard :mod:`pwd` module. This is done by the
-   :func:`os.path.expanduser` function used by Packaging.
+   from the standard :mod:`pwd` module. Packaging uses the
+   :func:`os.path.expanduser` function to do this.
 
 (3)
-   I.e., in the current directory (usually the location of the setup script).
+   I.e., in the current directory (usually the location from which the Packaging
+   command is issued).
 
 (4)
    (See also note (1).) Python's default installation prefix is
 (5)
    On Windows, if the :envvar:`HOME` environment variable is not defined,
    :envvar:`USERPROFILE` then :envvar:`HOMEDRIVE` and :envvar:`HOMEPATH` will
-   be tried. This is done by the :func:`os.path.expanduser` function used
-   by Packaging.
+   be tried. Packaging uses the :func:`os.path.expanduser` function to do this.
 
 
 .. _packaging-config-syntax: