Skip to content

Commit 55b2401

Browse files
nathanczhnchanwork
andauthored
Updated CLI documentation with config file name (pypa#2602)
Co-authored-by: Nathan Chan <nathan.chan@capitalone.com>
1 parent 0fd290d commit 55b2401

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

docs/cli_interface.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,10 @@ Defaults
3232
Configuration file
3333
^^^^^^^^^^^^^^^^^^
3434

35-
virtualenv looks for a standard ini configuration file. The exact location depends on the operating system you're using,
36-
as determined by :pypi:`platformdirs` application configuration definition. The configuration file location is printed as at
37-
the end of the output when ``--help`` is passed.
35+
Unless ``VIRTUALENV_CONFIG_FILE`` is set, virtualenv looks for a standard ``virtualenv.ini`` configuration file.
36+
The exact location depends on the operating system you're using, as determined by :pypi:`platformdirs` application
37+
configuration definition. It can be overridden by setting the ``VIRTUALENV_CONFIG_FILE`` environment variable.
38+
The configuration file location is printed as at the end of the output when ``--help`` is passed.
3839

3940
The keys of the settings are derived from the command line option (left strip the ``-`` characters, and replace ``-``
4041
with ``_``). Where multiple flags are available first found wins (where order is as it shows up under the ``--help``).

0 commit comments

Comments
 (0)