From d4b9e187aa7cc5ab14b2339f6171f7f2ea6504e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul?= Date: Tue, 19 Jul 2022 10:39:11 +0200 Subject: [PATCH] Add clarifications to the installation report documentation --- docs/html/reference/installation-report.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/html/reference/installation-report.md b/docs/html/reference/installation-report.md index d3f582bc613..fff37242d04 100644 --- a/docs/html/reference/installation-report.md +++ b/docs/html/reference/installation-report.md @@ -6,6 +6,19 @@ The `--report` option of the pip install command produces a detailed JSON report of what it did install (or what it would have installed, if used with the `--dry-run` option). +```{note} +When considering use cases, please bear in mind that + +- while the `--report` option may be used to implement requirement locking tools (among + other use cases), this format is *not* meant to be a lock file format as such; +- there is no plan for pip to accept an installation report as input for the `install`, + `download` or `wheel` commands; +- the `--report` option and this format is intended to become a supported pip feature + (when the format is stabilized to version 1); +- it is however *not* a PyPA interoperability standard and as such its evolution will be + governed by the pip processes and not the PyPA standardization processes. +``` + ## Specification The report is a JSON object with the following properties: