Re: [PATCH v3 1/6] show-ref doc: update for internal consistency
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- May 15, 2023, 16:58 UTC
- Message-ID
- <CAPig+cTSp3+RDbULeOXpfXwXw35tj3o-CTrpaeRPSB8remKk4A@mail.gmail.com>
- In-Reply-To
- <fe442c2041b01985a4ecb0f2e9651231af2a439b.1684152793.git.gitgitgadget@gmail.com>
On Mon, May 15, 2023 at 8:13 AM Sean Allred via GitGitGadget <gitgitgadget@gmail.com> wrote:
Show 26 quoted lines
> - 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?