From e5bebe06b6b8e88a856c19d43915e426af4f38ec Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Mon, 19 Aug 2024 16:26:09 -0500 Subject: [PATCH] Document the `uv.pip` section semantics (#6225) Explains semantics for `[uv.pip]` settings. --- docs/configuration/files.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/configuration/files.md b/docs/configuration/files.md index 4b7cf4dc2..af88232a6 100644 --- a/docs/configuration/files.md +++ b/docs/configuration/files.md @@ -57,3 +57,15 @@ configuration files (e.g., user-level configuration will be ignored). ## Settings See the [settings reference](../reference/settings.md) for an enumeration of the available settings. + +## Configuring the pip interface + +A dedicated [`[uv.pip]`](../reference/settings.md#pip) section is provided for configuring _just_ +the `uv pip` command line interface. Settings in this section will not apply to `uv` commands +outside of the `uv pip` namespace. However, many of the settings in this section have corollaries in +the top-level namespace which _do_ apply to the `uv pip` interface unless they are overridden by a +value in the `uv.pip` section. + +The `uv.pip` settings are designed to adhere closely to pip's interface and are declared separately +to retain compatibility while allowing the global settings to use alternate designs (e.g., +`--no-build`).