summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPhil Elson <philip.elson@cern.ch>2022-11-17 17:25:30 +0100
committerPhil Elson <philip.elson@cern.ch>2022-11-17 17:31:26 +0100
commit81d6053ee3ce5c4a8b0572cb80c542ab9f7e461e (patch)
tree14fa5707cde92a55d1e6592ee2e5092b55bf7c4a /docs
parent93ade8586e3eb3792250f1f0eb924c1664bc4df7 (diff)
downloadpip-81d6053ee3ce5c4a8b0572cb80c542ab9f7e461e.tar.gz
Use the VIRTUAL_ENV environment variable in the configuration documentation
This follows the discussion in https://github.com/pypa/pip/pull/11487/files#r988625394, that despite the VIRTUAL_ENV environment variable not being the technically correct value, it is more readily understood by readers than ``sys.prefix``.
Diffstat (limited to 'docs')
-rw-r--r--docs/html/topics/configuration.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/html/topics/configuration.md b/docs/html/topics/configuration.md
index ddeee0826..521bc9af4 100644
--- a/docs/html/topics/configuration.md
+++ b/docs/html/topics/configuration.md
@@ -52,7 +52,7 @@ Base
: {file}`\{sys.base_prefix\}/pip.conf`
Site
-: {file}`\{sys.prefix\}/pip.conf`
+: {file}`$VIRTUAL_ENV/pip.conf`
```
```{tab} MacOS
@@ -71,7 +71,7 @@ Base
: {file}`\{sys.base_prefix\}/pip.conf`
Site
-: {file}`\{sys.prefix\}/pip.conf`
+: {file}`$VIRTUAL_ENV/pip.conf`
```
```{tab} Windows
@@ -92,7 +92,7 @@ Base
: {file}`\{sys.base_prefix\}\\pip.ini`
Site
-: {file}`\{sys.prefix\}\\pip.ini`
+: {file}`%VIRTUAL_ENV%\\pip.ini`
```
### `PIP_CONFIG_FILE`