Skip to content

Updated CLI documentation with config file name #2602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 10, 2023
Merged

Updated CLI documentation with config file name #2602

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50cea19
Updated CLI documentation with config file name
nchanwork Jul 10, 2023
40ee9f5
Lint fixes
nchanwork Jul 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/cli_interface.rst
View file
Open in desktop
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