improve documentation for install_command (#2111)

Co-authored-by: Bernát Gábor <[email protected]>
tox-dev · Jul 21, 2021 · 20d0646 · 20d0646
1 parent b35565a
commit 20d0646
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/changelog/2081.doc.rst 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
@@ -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
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The documentation of ``install_command`` now also mentions that you can provide arbitrary commands - by :user:`jugmac00`