From 7753e72528bd52f536ded9d734518bf3276a9225 Mon Sep 17 00:00:00 2001 From: Grzegorz Bokota Date: Thu, 19 Jan 2023 02:24:11 +0100 Subject: [PATCH] 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> --- docs/changelog/2883.doc.rst | 1 + docs/config.rst | 2 ++ 2 files changed, 3 insertions(+) create mode 100644 docs/changelog/2883.doc.rst diff --git a/docs/changelog/2883.doc.rst b/docs/changelog/2883.doc.rst new file mode 100644 index 000000000..8472f903b --- /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 8569c5553..e80da0667 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::