Mention --quiet in --report option help

pypa · Aug 7, 2022 · 77da6ae · 77da6ae
1 parent 8dc39f0
commit 77da6ae
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/news/11357.doc.rst b/news/11357.doc.rst
@@ -0,0 +1 @@
+Mention that --quiet must be used when writing the installation report to stdout.
diff --git a/src/pip/_internal/commands/install.py b/src/pip/_internal/commands/install.py
@@ -263,7 +263,9 @@ def add_options(self) -> None:
                 "the provided requirements. "
                 "Can be used in combination with --dry-run and --ignore-installed "
                 "to 'resolve' the requirements. "
-                "When - is used as file name it writes to stdout."
+                "When - is used as file name it writes to stdout. "
+                "When writing to stdout, please combine with the --quiet option "
+                "to avoid mixing pip logging output with JSON output."
             ),
         )