Thread (22 messages) 22 messages, 4 authors, 2023-05-19

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

From: Eric Sunshine <hidden>
Date: 2023-05-15 16:59:09

On Mon, May 15, 2023 at 8:13 AM Sean Allred via GitGitGadget
[off-list ref] wrote:
quoted hunk ↗ jump to hunk
- 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?
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help