Junio C Hamano [off-list ref] writes:

Eric Sunshine [off-list ref] writes:

quoted

On Mon, May 15, 2023 at 8:13 AM Sean Allred via GitGitGadget
[off-list ref] wrote:

quoted

- 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 <redacted>
---

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/ (local)

Nice catch; this has been fixed for the next iteration.

--
Sean Allred