Skip to content

Commit

Permalink
Recommend a specific config file to use and format user config as a w…
Browse files Browse the repository at this point in the history
…arning.
  • Loading branch information
nuclearsandwich committed Aug 9, 2024
1 parent 73ed28a commit f1dffc6
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/pip_and_pep_668.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,17 @@ Configure using pip.conf
`Pip configuration files <pip-configuration>`_ can be used to set the desired behavior
Pip checks for global configuration files in ``XDG_CONFIG_DIRS``, as well as ``/etc/pip.conf``
For details on ``XDG_CONFIG_DIRS`` refer to the `XDG base directories specification <xdg-base-dirs>`_.

Creating a pip.conf in your user account's ``XDG_CONFIG_HOME`` (e.g. ``~/.config/pip/pip.conf``) does not appear to be sufficent when installing packages globally.
If you're unsure which configuration file is in use by your system, ``/etc/pip.conf`` seems like the most generic.

.. code-block:: ini
[install]
break-system-packages = true
.. warning:: Creating a pip.conf in your user account's ``XDG_CONFIG_HOME`` (e.g. ``~/.config/pip/pip.conf``) does not appear to be sufficent when installing packages globally.


Configuring for CI setup
------------------------

Expand Down

0 comments on commit f1dffc6

Please sign in to comment.