git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v3 1/6] show-ref doc: update for internal consistency

From
Junio C Hamano <gitster@pobox.com>
Date
May 15, 2023, 17:27 UTC
Message-ID
<xmqqilcta4j2.fsf@gitster.g>
In-Reply-To
<CAPig+cTSp3+RDbULeOXpfXwXw35tj3o-CTrpaeRPSB8remKk4A@mail.gmail.com>
Eric Sunshine <sunshine@sunshineco.com> writes:
Show 31 quoted lines
> 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/
Previous: Eric SunshineNext: Sean Allred
Message 15 of 33 in “Document the output format of ls-remote”
  1. Document the output format of ls-remoteSean Allred via GitGitGadget, Mar 18, 2023
  2. Eric SunshineMar 19, 2023
  3. Felipe ContrerasMar 19, 2023
  4. Sean AllredMar 19, 2023
  5. 0/2 Document the output format of ls-remoteSean Allred via GitGitGadget, Mar 22, 2023
  6. 2/2 Document the output format of ls-remoteSean Allred via GitGitGadget, Mar 22, 2023
  7. Junio C HamanoMar 22, 2023
  8. Re* [PATCH v2 2/2] Document the output format of ls-remoteJunio C Hamano, Mar 22, 2023
  9. 1/2 Update show-ref documentation for internal consistencySean Allred via GitGitGadget, Mar 22, 2023
  10. Junio C HamanoMar 22, 2023
  11. 0/6 Document the output format of ls-remoteSean Allred via GitGitGadget, May 15, 2023
  12. 2/6 show-branch doc: say <ref>, not <reference>Junio C Hamano via GitGitGadget, May 15, 2023
  13. 1/6 show-ref doc: update for internal consistencySean Allred via GitGitGadget, May 15, 2023
  14. Eric SunshineMay 15, 2023
  15. Junio C HamanoMay 15, 2023
  16. Sean AllredMay 19, 2023
  17. Junio C HamanoMay 15, 2023
  18. Sean AllredMay 19, 2023
  19. 3/6 ls-remote doc: remove redundant --tags exampleSean Allred via GitGitGadget, May 15, 2023
  20. Junio C HamanoMay 15, 2023
  21. 5/6 ls-remote doc: explain what each example doesSean Allred via GitGitGadget, May 15, 2023
  22. 4/6 ls-remote doc: show peeled tags in examplesSean Allred via GitGitGadget, May 15, 2023
  23. Junio C HamanoMay 15, 2023
  24. 6/6 ls-remote doc: document the output formatSean Allred via GitGitGadget, May 15, 2023
  25. Junio C HamanoMay 15, 2023
  26. Sean AllredMay 19, 2023
  27. 0/6 Document the output format of ls-remoteSean Allred via GitGitGadget, May 19, 2023
  28. 1/6 show-ref doc: update for internal consistencySean Allred via GitGitGadget, May 19, 2023
  29. 2/6 show-branch doc: say <ref>, not <reference>Junio C Hamano via GitGitGadget, May 19, 2023
  30. 3/6 ls-remote doc: remove redundant --tags exampleSean Allred via GitGitGadget, May 19, 2023
  31. 4/6 ls-remote doc: show peeled tags in examplesSean Allred via GitGitGadget, May 19, 2023
  32. 5/6 ls-remote doc: explain what each example doesSean Allred via GitGitGadget, May 19, 2023
  33. 6/6 ls-remote doc: document the output formatSean Allred via GitGitGadget, May 19, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.