Skip to content

Commit 790725a

Browse files
authored
Merge pull request #11274 from sbidoul/install-report-note-sbi
Add clarifications to the installation report documentation
2 parents b1a01ef + d4b9e18 commit 790725a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/html/reference/installation-report.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,19 @@
66
The `--report` option of the pip install command produces a detailed JSON report of what
77
it did install (or what it would have installed, if used with the `--dry-run` option).
88

9+
```{note}
10+
When considering use cases, please bear in mind that
11+
12+
- while the `--report` option may be used to implement requirement locking tools (among
13+
other use cases), this format is *not* meant to be a lock file format as such;
14+
- there is no plan for pip to accept an installation report as input for the `install`,
15+
`download` or `wheel` commands;
16+
- the `--report` option and this format is intended to become a supported pip feature
17+
(when the format is stabilized to version 1);
18+
- it is however *not* a PyPA interoperability standard and as such its evolution will be
19+
governed by the pip processes and not the PyPA standardization processes.
20+
```
21+
922
## Specification
1023

1124
The report is a JSON object with the following properties:

0 commit comments

Comments
 (0)