Skip to content

Commit

Permalink
Updated CLI documentation with config file name (#2602)
Browse files Browse the repository at this point in the history
Co-authored-by: Nathan Chan <[email protected]>
  • Loading branch information
nathanczh and nchanwork authored Jul 10, 2023
1 parent 0fd290d commit 55b2401
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/cli_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ Defaults
Configuration file
^^^^^^^^^^^^^^^^^^

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

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

0 comments on commit 55b2401

Please sign in to comment.