summaryrefslogtreecommitdiffstats
path: root/Doc/library/sys.rst
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2012-07-09 09:37:01 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2012-07-09 09:37:01 (GMT)
commitcd9b746b37fae46df2a8b669b5965272ab565ff8 (patch)
treedc9322c0ce6c1e2adf4ad247b8141f7f6e69a332 /Doc/library/sys.rst
parent6dc9f0eca7ac25519b4dd54de48d0ba1af56344f (diff)
downloadcpython-cd9b746b37fae46df2a8b669b5965272ab565ff8.zip
cpython-cd9b746b37fae46df2a8b669b5965272ab565ff8.tar.gz
cpython-cd9b746b37fae46df2a8b669b5965272ab565ff8.tar.bz2
Added cross-references to venv definition.
Diffstat (limited to 'Doc/library/sys.rst')
-rw-r--r--Doc/library/sys.rst25
1 files changed, 14 insertions, 11 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 1516e3c..cd6d4bf 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -32,10 +32,11 @@ always available.
.. data:: base_exec_prefix
Set during Python startup, before ``site.py`` is run, to the same value as
- :data:`exec_prefix`. If not running in a virtual environment, the values
- will stay the same; if ``site.py`` finds that a virtual environment is in
- use, the values of :data:`prefix` and :data:`exec_prefix` will be changed to
- point to the virtual environment, whereas :data:`base_prefix` and
+ :data:`exec_prefix`. If not running in a
+ :ref:`virtual environment <venv-def>`, the values will stay the same; if
+ ``site.py`` finds that a virtual environment is in use, the values of
+ :data:`prefix` and :data:`exec_prefix` will be changed to point to the
+ virtual environment, whereas :data:`base_prefix` and
:data:`base_exec_prefix` will remain pointing to the base Python
installation (the one which the virtual environment was created from).
@@ -45,7 +46,7 @@ always available.
.. data:: base_prefix
Set during Python startup, before ``site.py`` is run, to the same value as
- :data:`prefix`. If not running in a virtual environment, the values
+ :data:`prefix`. If not running in a :ref:`virtual environment <venv-def>`, the values
will stay the same; if ``site.py`` finds that a virtual environment is in
use, the values of :data:`prefix` and :data:`exec_prefix` will be changed to
point to the virtual environment, whereas :data:`base_prefix` and
@@ -241,9 +242,10 @@ always available.
installed in :file:`{exec_prefix}/lib/python{X.Y}/lib-dynload`, where *X.Y*
is the version number of Python, for example ``3.2``.
- .. note:: If a virtual environment is in effect, this value will be changed
- in ``site.py`` to point to the virtual environment. The value for the
- Python installation will still be available, via :data:`base_exec_prefix`.
+ .. note:: If a :ref:`virtual environment <venv-def>` is in effect, this
+ value will be changed in ``site.py`` to point to the virtual environment.
+ The value for the Python installation will still be available, via
+ :data:`base_exec_prefix`.
.. data:: executable
@@ -865,9 +867,10 @@ always available.
stored in :file:`{prefix}/include/python{X.Y}`, where *X.Y* is the version
number of Python, for example ``3.2``.
- .. note:: If a virtual environment is in effect, this value will be changed
- in ``site.py`` to point to the virtual environment. The value for the
- Python installation will still be available, via :data:`base_prefix`.
+ .. note:: If a :ref:`virtual environment <venv-def>` is in effect, this
+ value will be changed in ``site.py`` to point to the virtual
+ environment. The value for the Python installation will still be
+ available, via :data:`base_prefix`.
.. data:: ps1