diff mbox series

[1/3] t/README: document GIT_TEST_DEFAULT_HASH

Message ID 242a44b63c8fc0ab7e8d8a6a913fde71444f931d.1597428440.git.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series [1/3] t/README: document GIT_TEST_DEFAULT_HASH | expand

Commit Message

Jean-Noël Avila via GitGitGadget Aug. 14, 2020, 6:07 p.m. UTC 
From: Derrick Stolee <dstolee@microsoft.com>

Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
---
 t/README | 3 +++
 1 file changed, 3 insertions(+)

Comments

Junio C Hamano Aug. 14, 2020, 7:02 p.m. UTC | #1 
"Derrick Stolee via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Derrick Stolee <dstolee@microsoft.com>
>
> Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
> ---
>  t/README | 3 +++
>  1 file changed, 3 insertions(+)

Very helpful.  Will queue.

>
> diff --git a/t/README b/t/README
> index 70ec61cf88..ecf8c7291d 100644
> --- a/t/README
> +++ b/t/README
> @@ -421,6 +421,9 @@ GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=<boolean>, when true (which is
>  the default when running tests), errors out when an abbreviated option
>  is used.
>  
> +GIT_TEST_DEFAULT_HASH=<sha1|sha256> specifies which hash algorithm to use
> +in the test scripts.
> +
>  Naming Tests
>  ------------
Eric Sunshine Aug. 14, 2020, 8:39 p.m. UTC | #2 
On Fri, Aug 14, 2020 at 2:07 PM Derrick Stolee via GitGitGadget
<gitgitgadget@gmail.com> wrote:
> diff --git a/t/README b/t/README
> @@ -421,6 +421,9 @@ GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=<boolean>, when true> +GIT_TEST_DEFAULT_HASH=<sha1|sha256> specifies which hash algorithm to use
> +in the test scripts.

Nit: The documentation for all the other environment variables has the
form `GIT_VAR=<generic-value-indicator>` rather than placing the
possible literal values within the angle brackets. So, perhaps this
can be written as:

    GIT_TEST_DEFAULT_HASH=<hash-algo> specifies which hash algorithm
    to use in the test scripts. Recognized values for <hash-algo> are
    "sha1" and "sha256".
Derrick Stolee Aug. 14, 2020, 8:41 p.m. UTC | #3 
On 8/14/2020 4:39 PM, Eric Sunshine wrote:
> On Fri, Aug 14, 2020 at 2:07 PM Derrick Stolee via GitGitGadget
> <gitgitgadget@gmail.com> wrote:
>> diff --git a/t/README b/t/README
>> @@ -421,6 +421,9 @@ GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=<boolean>, when true> +GIT_TEST_DEFAULT_HASH=<sha1|sha256> specifies which hash algorithm to use
>> +in the test scripts.
> 
> Nit: The documentation for all the other environment variables has the
> form `GIT_VAR=<generic-value-indicator>` rather than placing the
> possible literal values within the angle brackets. So, perhaps this
> can be written as:
> 
>     GIT_TEST_DEFAULT_HASH=<hash-algo> specifies which hash algorithm
>     to use in the test scripts. Recognized values for <hash-algo> are
>     "sha1" and "sha256".

Sounds good!

Thanks,
-Stolee
diff mbox series

Patch

diff --git a/t/README b/t/README
index 70ec61cf88..ecf8c7291d 100644
--- a/t/README
+++ b/t/README
@@ -421,6 +421,9 @@  GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=<boolean>, when true (which is
 the default when running tests), errors out when an abbreviated option
 is used.
 
+GIT_TEST_DEFAULT_HASH=<sha1|sha256> specifies which hash algorithm to use
+in the test scripts.
+
 Naming Tests
 ------------