From 20d0646554db9d503afe5b140518cbcb95c2c4de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Gmach?= Date: Thu, 22 Jul 2021 00:13:49 +0200 Subject: [PATCH] improve documentation for `install_command` (#2111) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bernát Gábor --- docs/changelog/2081.doc.rst | 1 + docs/config.rst | 7 +++++++ 2 files changed, 8 insertions(+) create mode 100644 docs/changelog/2081.doc.rst diff --git a/docs/changelog/2081.doc.rst b/docs/changelog/2081.doc.rst new file mode 100644 index 000000000..1e0a11078 --- /dev/null +++ b/docs/changelog/2081.doc.rst @@ -0,0 +1 @@ +The documentation of ``install_command`` now also mentions that you can provide arbitrary commands - by :user:`jugmac00` diff --git a/docs/config.rst b/docs/config.rst index c0158c27b..34aad3556 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -306,6 +306,13 @@ Complete list of settings that you can put into ``testenv*`` sections: such as ``--pre`` (configured as ``pip_pre``) and potentially index-options from the deprecated :conf:`indexserver` option. + .. note:: + + You can also provide arbitrary commands to the ``install_command``. Please take care that these commands can be + executed on the supported operating systems. When executing shell scripts we recommend to not specify the script + directly but instead pass it to the appropriate shell as argument (e.g. prefer ``bash script.sh`` over + ``script.sh``). + .. conf:: list_dependencies_command ^ ARGV ^ python -m pip freeze .. versionadded:: 2.4