From: Junio C Hamano <gitster@pobox.com>
Date: Mon, 15 May 2023 17:27:45 GMT
Subject: Re: [PATCH v3 1/6] show-ref doc: update for internal consistency
Message-ID: <xmqqilcta4j2.fsf@gitster.g>
In-Reply-To: <CAPig+cTSp3+RDbULeOXpfXwXw35tj3o-CTrpaeRPSB8remKk4A@mail.gmail.com>

Eric Sunshine <sunshine@sunshineco.com> writes:

> On Mon, May 15, 2023 at 8:13 AM Sean Allred via GitGitGadget
> <gitgitgadget@gmail.com> wrote:
>> - Use inline-code syntax for options where appropriate.
>> - Use code blocks to clarify output format.
>>
>> This patch also swaps out 'SHA-1' language for the implementation-
>> agnostic 'OID' term where appropriate in preparation for supporting
>> different hashing algorithms.
>>
>> Signed-off-by: Sean Allred <allred.sean@gmail.com>
>> ---
>> diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
>> @@ -96,7 +96,13 @@ OPTIONS
>> -The output is in the format: '<SHA-1 ID>' '<space>' '<reference name>'.
>> +The output is in the format:
>> +
>> +------------
>> +<oid> SP <ref> LF
>> +------------
>>  $ git show-ref --head --dereference
>> @@ -110,7 +116,13 @@ $ git show-ref --head --dereference
>> -When using --hash (and not --dereference) the output format is: '<SHA-1 ID>'
>> +When using `--hash` (and not `--dereference`), the output is in the format:
>> +
>> +------------
>> +<OID> LF
>> +------------
>>  $ git show-ref --heads --hash
>
> Is the difference in case ("<oid>" vs. "<OID>") intentional between
> these two examples?

I think it is an incomplete fix based on the suggestion I made for
the previous round,

 cf. https://lore.kernel.org/git/xmqqsfdwenn3.fsf@gitster.g/