Skip to content

Correct macOS XDG configuration documentation #14207

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
ichard26 merged 1 commit into from
Jul 26, 2026
+15 −8
Merged

Correct macOS XDG configuration documentation #14207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 15 additions & 8 deletions docs/html/topics/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,23 @@ Site
```{tab} MacOS

Global
: In a "pip" subdirectory of any of the paths set in the environment variable
`XDG_DATA_DIRS` (if it exists), for example {file}`/etc/xdg/pip/pip.conf`.
: In a "pip" subdirectory of each path listed in the environment
variable `XDG_DATA_DIRS` (if it is non-empty).

This will be followed by loading {file}`/Library/Application Support/pip/pip.conf`.
If `XDG_DATA_DIRS` is unset or empty,
{file}`/Library/Application Support/pip/pip.conf` is loaded instead
(run `pip config debug` to identify the exact paths).

User
: {file}`$HOME/Library/Application Support/pip/pip.conf`
if directory `$HOME/Library/Application Support/pip` exists
else {file}`$HOME/.config/pip/pip.conf`, which respects the
`XDG_DATA_HOME` environment variable.
: The user configuration file is loaded from one of the following
locations:

* {file}`$XDG_DATA_HOME/pip/pip.conf`, if `XDG_DATA_HOME` is
non-empty and {file}`$XDG_DATA_HOME/pip` exists.
* {file}`$HOME/Library/Application Support/pip/pip.conf`, if
`XDG_DATA_HOME` is unset or empty and
{file}`$HOME/Library/Application Support/pip` exists.
* {file}`$HOME/.config/pip/pip.conf`, otherwise.

The legacy "per-user" configuration file is also loaded, if it exists: {file}`$HOME/.pip/pip.conf`.

Expand Down Expand Up @@ -97,7 +104,7 @@ Site
```

```{versionchanged} 26.2
pip will also respect `XDG_CONFIG_DIRS` and `XDG_CONFIG_HOME` on macOS.
Pip will also respect `XDG_DATA_DIRS` and `XDG_DATA_HOME` on macOS.
```

### `PIP_CONFIG_FILE`
Expand Down