Re: [PATCH 1/2] t/README: document test_config

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 14, 2021, 07:02 UTC
Message-ID: <CAPig+cRrVN0cqoRFA90XYSsDcJ-PZxLMNfFCye4pUXz47AhpYw@mail.gmail.com>
In-Reply-To: <20210514065508.247044-1-firminmartin24@gmail.com>

On Fri, May 14, 2021 at 2:55 AM Firmin Martin <firminmartin24@gmail.com> wrote:

Show 13 quoted lines

> test_config is used over one thousand times in the test suite, yet not
> documented. Give it a place in the "Test harness library" section.
>
> Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
> ---
> diff --git a/t/README b/t/README
> @@ -1046,6 +1046,21 @@ library for your script to use.
> + - test_config <config-option> [<value>]
> +
> +   Set the configuration option <config-option> to <value>, and unset it at the
> +   end of the current test. For a similar purpose, test_config_global for
> +   global configuration is also available. Note, however, that test_config_*
> +   should not be used under a subshell.

"should" is perhaps too weak of a word. test_config() will not function correctly at all (just as test_when_finished() will not function correctly) within a subshell. So, perhaps say "must not be used in a subshell."