summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGrzegorz Bokota <bokota+github@gmail.com>2023-01-19 02:24:11 +0100
committerGitHub <noreply@github.com>2023-01-18 17:24:11 -0800
commit7753e72528bd52f536ded9d734518bf3276a9225 (patch)
treecb9a3c9aec234664be19610a60d2f84ac88f4ecf
parent7eec0251e6885fd025f745949c584f8ca44ffbb6 (diff)
downloadtox-git-7753e72528bd52f536ded9d734518bf3276a9225.tar.gz
Add more explanation to `list_dependencies_command` configuration option (#2883)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
-rw-r--r--docs/changelog/2883.doc.rst1
-rw-r--r--docs/config.rst2
2 files changed, 3 insertions, 0 deletions
diff --git a/docs/changelog/2883.doc.rst b/docs/changelog/2883.doc.rst
new file mode 100644
index 00000000..8472f903
--- /dev/null
+++ b/docs/changelog/2883.doc.rst
@@ -0,0 +1 @@
+Add infromation when command from ``list_dependencies_command`` configuration option is used.
diff --git a/docs/config.rst b/docs/config.rst
index 8569c555..e80da066 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -742,6 +742,8 @@ Pip installer
:version_added: 2.4
The ``list_dependencies_command`` setting is used for listing the packages installed into the virtual environment.
+ This command will be executed only if executing on Contionous Integrations is detected (for example set environment variable ``CI=1``)
+ or if journal is active.
.. conf::