From 73865877cbbafe82c2a69f7dd9bd42634f574e4b Mon Sep 17 00:00:00 2001 From: Kai Chen Date: Sun, 31 Mar 2019 19:56:13 -0700 Subject: [PATCH] Document enabling --no-warn-script-location with falsy values Closes https://github.com/pypa/pip/issues/6209 --- docs/html/user_guide.rst | 5 +++-- news/31044E84-3F3C-48A8-84B2-6028E21FEBF1.trivial | 0 src/pip/_internal/commands/install.py | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 news/31044E84-3F3C-48A8-84B2-6028E21FEBF1.trivial diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 9b7e7ed4a0f..4d0477d0d20 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -396,8 +396,8 @@ set like this: ignore-installed = true no-dependencies = yes -To enable the boolean options ``--no-compile`` and ``--no-cache-dir``, falsy -values have to be used: +To enable the boolean options ``--no-compile``, ``--no-warn-script-location`` +and ``--no-cache-dir``, falsy values have to be used: .. code-block:: ini @@ -406,6 +406,7 @@ values have to be used: [install] no-compile = no + no-warn-script-location = false Appending options like ``--find-links`` can be written on multiple lines: diff --git a/news/31044E84-3F3C-48A8-84B2-6028E21FEBF1.trivial b/news/31044E84-3F3C-48A8-84B2-6028E21FEBF1.trivial new file mode 100644 index 00000000000..e69de29bb2d diff --git a/src/pip/_internal/commands/install.py b/src/pip/_internal/commands/install.py index c13da44c6c3..64aa1c55861 100644 --- a/src/pip/_internal/commands/install.py +++ b/src/pip/_internal/commands/install.py @@ -215,7 +215,8 @@ def __init__(self, *args, **kw): action="store_false", dest="warn_script_location", default=True, - help="Do not warn when installing scripts outside PATH", + help="Do not warn when installing scripts outside PATH. Must use " + "falsy value to enable.", ) cmd_opts.add_option( "--no-warn-conflicts",