From 44bb7164ddefc214ee67c9e99080fc6f053ec805 Mon Sep 17 00:00:00 2001 From: Emmanuel Arias Date: Sat, 25 Jul 2020 09:56:53 -0300 Subject: [PATCH 1/4] Fix description of config files User Guide This PR make consitence User Guide with pip config file --- 759f489e-80da-4dac-8d7d-13c471f1cee9.trivial | 0 docs/html/user_guide.rst | 10 +++++----- 2 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 759f489e-80da-4dac-8d7d-13c471f1cee9.trivial diff --git a/759f489e-80da-4dac-8d7d-13c471f1cee9.trivial b/759f489e-80da-4dac-8d7d-13c471f1cee9.trivial new file mode 100644 index 000000000..e69de29bb diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 10856e335..16585f12d 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -342,7 +342,7 @@ pip allows you to set all command line option defaults in a standard ini style config file. The names and locations of the configuration files vary slightly across -platforms. You may have per-user, per-virtualenv or site-wide (shared amongst +platforms. You may have per-user, per-virtualenv or global (shared amongst all users) configuration: **Per-user**: @@ -369,7 +369,7 @@ variable ``PIP_CONFIG_FILE``. * On Unix and macOS the file is :file:`$VIRTUAL_ENV/pip.conf` * On Windows the file is: :file:`%VIRTUAL_ENV%\\pip.ini` -**Site-wide**: +**Global**: * On Unix the file may be located in :file:`/etc/pip.conf`. Alternatively it may be in a "pip" subdirectory of any of the paths set in the @@ -380,17 +380,17 @@ variable ``PIP_CONFIG_FILE``. :file:`C:\\Documents and Settings\\All Users\\Application Data\\pip\\pip.ini` * On Windows 7 and later the file is hidden, but writeable at :file:`C:\\ProgramData\\pip\\pip.ini` -* Site-wide configuration is not supported on Windows Vista +* System-wide configuration is not supported on Windows Vista If multiple configuration files are found by pip then they are combined in the following order: -1. The site-wide file is read +1. The system-wide file is read 2. The per-user file is read 3. The virtualenv-specific file is read Each file read overrides any values read from previous files, so if the -global timeout is specified in both the site-wide file and the per-user file +global timeout is specified in both the system-wide file and the per-user file then the latter value will be used. The names of the settings are derived from the long command line option, e.g. From ead83f38b485e074366dd92f4d351092385f056c Mon Sep 17 00:00:00 2001 From: Emmanuel Arias Date: Sat, 25 Jul 2020 10:00:42 -0300 Subject: [PATCH 2/4] fix news --- .../759f489e-80da-4dac-8d7d-13c471f1cee9.trivial | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename 759f489e-80da-4dac-8d7d-13c471f1cee9.trivial => news/759f489e-80da-4dac-8d7d-13c471f1cee9.trivial (100%) diff --git a/759f489e-80da-4dac-8d7d-13c471f1cee9.trivial b/news/759f489e-80da-4dac-8d7d-13c471f1cee9.trivial similarity index 100% rename from 759f489e-80da-4dac-8d7d-13c471f1cee9.trivial rename to news/759f489e-80da-4dac-8d7d-13c471f1cee9.trivial From f887252d33106bdd15aabfafe80ee29142be5d78 Mon Sep 17 00:00:00 2001 From: Emmanuel Arias Date: Sat, 25 Jul 2020 14:03:31 -0300 Subject: [PATCH 3/4] use global instead of system-wide specific on doc that global config file is shared by all python installation --- docs/html/user_guide.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 16585f12d..9efa9703c 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -380,17 +380,19 @@ variable ``PIP_CONFIG_FILE``. :file:`C:\\Documents and Settings\\All Users\\Application Data\\pip\\pip.ini` * On Windows 7 and later the file is hidden, but writeable at :file:`C:\\ProgramData\\pip\\pip.ini` -* System-wide configuration is not supported on Windows Vista +* Global configuration is not supported on Windows Vista. + +The global configuration file is shared by whole Python installation. If multiple configuration files are found by pip then they are combined in the following order: -1. The system-wide file is read +1. The global file is read 2. The per-user file is read 3. The virtualenv-specific file is read Each file read overrides any values read from previous files, so if the -global timeout is specified in both the system-wide file and the per-user file +global timeout is specified in both the global file and the per-user file then the latter value will be used. The names of the settings are derived from the long command line option, e.g. From 9671830c3e1f474203fee4f9638dca479e07ed3a Mon Sep 17 00:00:00 2001 From: Emmanuel Arias Date: Sat, 25 Jul 2020 18:15:01 -0300 Subject: [PATCH 4/4] Update docs/html/user_guide.rst Co-authored-by: Julian Berman --- docs/html/user_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 9efa9703c..f2e49fadf 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -382,7 +382,7 @@ variable ``PIP_CONFIG_FILE``. :file:`C:\\ProgramData\\pip\\pip.ini` * Global configuration is not supported on Windows Vista. -The global configuration file is shared by whole Python installation. +The global configuration file is shared by all Python installations. If multiple configuration files are found by pip then they are combined in the following order: