From 3403e12c06007c74553b5f8679f864bbd8e956af Mon Sep 17 00:00:00 2001 From: Martey Dodoo Date: Mon, 1 Mar 2021 14:19:30 -0500 Subject: [PATCH] Document that using overrides disables all wheels See #4118. Update documentation to state that using command line options on any requirements will disable all usage of wheels. Since this is unexpected behavior, move text to a warning. --- docs/html/reference/pip_install.rst | 8 ++++++-- news/9674.doc.rst | 1 + 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 news/9674.doc.rst diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst index 2a60e7188b4..7b4b1f72eaf 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -315,8 +315,12 @@ Per-requirement Overrides ------------------------- Since version 7.0 pip supports controlling the command line options given to -``setup.py`` via requirements files. This disables the use of wheels (cached or -otherwise) for that package, as ``setup.py`` does not exist for wheels. +``setup.py`` via requirements files. + +.. warning:: + +This disables the use of wheels (cached or otherwise), +as ``setup.py`` does not exist for wheels. The ``--global-option`` and ``--install-option`` options are used to pass options to ``setup.py``. For example: diff --git a/news/9674.doc.rst b/news/9674.doc.rst new file mode 100644 index 00000000000..dd5b68420ec --- /dev/null +++ b/news/9674.doc.rst @@ -0,0 +1 @@ +Clarify that using per-requirement overrides disables the usage of wheels.