Skip to content

Commit c6936ad

Browse files
authored
Merge pull request #8624 from eamanu/fix-8616
Fix description of config files User Guide
2 parents aff33ff + 9671830 commit c6936ad

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

docs/html/user_guide.rst

+7-5
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ pip allows you to set all command line option defaults in a standard ini
342342
style config file.
343343

344344
The names and locations of the configuration files vary slightly across
345-
platforms. You may have per-user, per-virtualenv or site-wide (shared amongst
345+
platforms. You may have per-user, per-virtualenv or global (shared amongst
346346
all users) configuration:
347347

348348
**Per-user**:
@@ -369,7 +369,7 @@ variable ``PIP_CONFIG_FILE``.
369369
* On Unix and macOS the file is :file:`$VIRTUAL_ENV/pip.conf`
370370
* On Windows the file is: :file:`%VIRTUAL_ENV%\\pip.ini`
371371

372-
**Site-wide**:
372+
**Global**:
373373

374374
* On Unix the file may be located in :file:`/etc/pip.conf`. Alternatively
375375
it may be in a "pip" subdirectory of any of the paths set in the
@@ -380,17 +380,19 @@ variable ``PIP_CONFIG_FILE``.
380380
:file:`C:\\Documents and Settings\\All Users\\Application Data\\pip\\pip.ini`
381381
* On Windows 7 and later the file is hidden, but writeable at
382382
:file:`C:\\ProgramData\\pip\\pip.ini`
383-
* Site-wide configuration is not supported on Windows Vista
383+
* Global configuration is not supported on Windows Vista.
384+
385+
The global configuration file is shared by all Python installations.
384386

385387
If multiple configuration files are found by pip then they are combined in
386388
the following order:
387389

388-
1. The site-wide file is read
390+
1. The global file is read
389391
2. The per-user file is read
390392
3. The virtualenv-specific file is read
391393

392394
Each file read overrides any values read from previous files, so if the
393-
global timeout is specified in both the site-wide file and the per-user file
395+
global timeout is specified in both the global file and the per-user file
394396
then the latter value will be used.
395397

396398
The names of the settings are derived from the long command line option, e.g.

news/759f489e-80da-4dac-8d7d-13c471f1cee9.trivial

Whitespace-only changes.

0 commit comments

Comments
 (0)