From cfb7f052771c870940f8393dc4add22ac96ef0e2 Mon Sep 17 00:00:00 2001 From: James Braza Date: Fri, 16 Jun 2023 23:11:54 -0700 Subject: [PATCH 1/4] Hyperlinked env var substitutions docs in set_env --- docs/config.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/config.rst b/docs/config.rst index ecc77450f..01227f0d8 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -300,6 +300,9 @@ Base options - each line is in KEY=VALUE format; both the key and the value are stripped, - there is no special handling of quotation marks, they are part of the key or value. + Also read `environment variable substitutions`_ + for extended information on working with environment variables. + .. conf:: :keys: parallel_show_output :default: False @@ -830,6 +833,8 @@ Special substitutions that accept additional colon-delimited ``:`` parameters cannot have a space after the ``:`` at the beginning of line (e.g. ``{posargs: magic}`` would be parsed as factorial ``{posargs``, having value magic). +.. _`environment variable substitutions`: + Environment variable substitutions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From b8d57ad5b9e2ccd6479e0f792d5603817f8889eb Mon Sep 17 00:00:00 2001 From: James Braza Date: Sat, 17 Jun 2023 00:00:49 -0700 Subject: [PATCH 2/4] Added link to pass_env and tweaked wording a bit --- docs/config.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 01227f0d8..27d9d118f 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -285,6 +285,9 @@ Base options tox invocation environment it is ignored. The list of environment variable names is not case sensitive, for example: passing ``A`` or ``a`` will pass through both ``A`` and ``a``. + More environment variable-related information + can be found in `environment variable substitutions`_. + .. conf:: :keys: set_env, setenv @@ -300,8 +303,8 @@ Base options - each line is in KEY=VALUE format; both the key and the value are stripped, - there is no special handling of quotation marks, they are part of the key or value. - Also read `environment variable substitutions`_ - for extended information on working with environment variables. + More environment variable-related information + can be found in `environment variable substitutions`_. .. conf:: :keys: parallel_show_output From b0e078863b577a735b49ef8d2497bfcf59e0a7ca Mon Sep 17 00:00:00 2001 From: James Braza Date: Sat, 17 Jun 2023 00:01:43 -0700 Subject: [PATCH 3/4] Added changelog entry --- docs/changelog/3039.doc.rst | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 docs/changelog/3039.doc.rst diff --git a/docs/changelog/3039.doc.rst b/docs/changelog/3039.doc.rst new file mode 100644 index 000000000..80ab5d408 --- /dev/null +++ b/docs/changelog/3039.doc.rst @@ -0,0 +1,2 @@ +Linked environment variable substitutions docs in +``set_env`` and ``pass_env`` config docs. From bf06a7e18aeacc176f63323fa6d2cbcf29740b68 Mon Sep 17 00:00:00 2001 From: James Braza Date: Sat, 17 Jun 2023 00:12:32 -0700 Subject: [PATCH 4/4] Using :ref: to preserve title name (avoid redefining name) --- docs/config.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 27d9d118f..b80de22d3 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -286,7 +286,7 @@ Base options passing ``A`` or ``a`` will pass through both ``A`` and ``a``. More environment variable-related information - can be found in `environment variable substitutions`_. + can be found in :ref:`environment variable substitutions`. .. conf:: :keys: set_env, setenv @@ -304,7 +304,7 @@ Base options - there is no special handling of quotation marks, they are part of the key or value. More environment variable-related information - can be found in `environment variable substitutions`_. + can be found in :ref:`environment variable substitutions`. .. conf:: :keys: parallel_show_output