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.
Thanks-to: Eric Sunshine <sunshine@xxxxxxxxxxxxxx>
Signed-off-by: Firmin Martin <firminmartin24@xxxxxxxxx>
---
t/README | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/t/README b/t/README
index 8eb9e46b1d..aaf1c9cadc 100644
--- a/t/README
+++ b/t/README
@@ -1046,6 +1046,21 @@ library for your script to use.
Abort the test script if either the value of the variable or the
default are not valid bool values.
+ - 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_*
+ must not be used in a subshell.
+
+ Example:
+
+ test_config format.coverLetter auto
+
+ Is a concise way to write:
+ test_when_finished "git config --unset format.coverLetter" &&
+ git config format.coverLetter auto
+
Prerequisites
-------------
--
2.31.1.443.g67a420f573
