Improve docs for --root-user-action option

Mr-Pepe · Mr-Pepe · commit a33aed0ac5da · 2024-01-31T20:42:04.000+08:00
diff --git a/news/514f0c13-84ee-4d81-8465-bae74e370d0b.trivial.rst b/news/514f0c13-84ee-4d81-8465-bae74e370d0b.trivial.rst
diff --git a/src/pip/_internal/cli/cmdoptions.py b/src/pip/_internal/cli/cmdoptions.py
@@ -903,7 +903,8 @@ def _handle_config_settings(
     dest="root_user_action",
     default="warn",
     choices=["warn", "ignore"],
-    help="Action if pip is run as a root user. By default, a warning message is shown.",
+    help="Action if pip is run as a root user ('warn' or 'ignore'). "
+    "By default, a warning message is shown.",
 )
 
 
diff --git a/src/pip/_internal/cli/req_command.py b/src/pip/_internal/cli/req_command.py
@@ -221,7 +221,9 @@ def warn_if_run_as_root() -> None:
         "Running pip as the 'root' user can result in broken permissions and "
         "conflicting behaviour with the system package manager. "
         "It is recommended to use a virtual environment instead: "
-        "https://pip.pypa.io/warnings/venv"
+        "https://pip.pypa.io/warnings/venv. "
+        "Use the --root-user-action option if you know what you are doing and "
+        "want to suppress this warning."
     )
 
 

Original file line number	Diff line number	Diff line change
`@@ -903,7 +903,8 @@ def _handle_config_settings(`
`903`	`903`	`dest="root_user_action",`
`904`	`904`	`default="warn",`
`905`	`905`	`choices=["warn", "ignore"],`
`906`		`- help="Action if pip is run as a root user. By default, a warning message is shown.",`
	`906`	`+ help="Action if pip is run as a root user ('warn' or 'ignore'). "`
	`907`	`+ "By default, a warning message is shown.",`
`907`	`908`	`)`
`908`	`909`
`909`	`910`
Original file line number	Diff line number	Diff line change
`@@ -221,7 +221,9 @@ def warn_if_run_as_root() -> None:`
`221`	`221`	`"Running pip as the 'root' user can result in broken permissions and "`
`222`	`222`	`"conflicting behaviour with the system package manager. "`
`223`	`223`	`"It is recommended to use a virtual environment instead: "`
`224`		`- "https://pip.pypa.io/warnings/venv"`
	`224`	`+ "https://pip.pypa.io/warnings/venv. "`
	`225`	`+ "Use the --root-user-action option if you know what you are doing and "`
	`226`	`+ "want to suppress this warning."`
`225`	`227`	`)`
`226`	`228`
`227`	`229`