Merge pull request #11274 from sbidoul/install-report-note-sbi

Add clarifications to the installation report documentation
pypa · Jul 20, 2022 · 790725a · 790725a
2 parents b1a01ef + d4b9e18
commit 790725a
Showing 1 changed file with 13 additions and 0 deletions.
diff --git 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: