mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

show-branch doc: say <ref>, not <reference>

Browse Source 
The glossary defines 'ref' as the official name of the thing,
and the output from "git grep -e '<ref' Documentation/" shows
that most everybody uses <ref>, not <reference>.  In addition,
the page already says <ref> in its SYNOPSIS section for the
command when it is used in the mode to follow the reflogs.

Strictly speaking, many references of these should be updated to
<commit> after adding an explanation on how these <commit>s are
discovered (i.e. we take <rev>, <glob>, or <ref> and starting from
these commits, follow their ancestry or reflog entries to list
commits), but that would be a lot bigger change I would rather not
to do in this patch, whose primary purpose is to make the existing
documentation more consistent.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Sean Allred <allred.sean@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano
2023-05-19 04:17:50 +00:00
parent 00bf685975
commit 0f45b5bc32
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/git-show-branch.txt
View File

@ -74,8 +74,7 @@ OPTIONS
that is the common ancestor of all the branches. This that is the common ancestor of all the branches. This
flag tells the command to go <n> more common commits flag tells the command to go <n> more common commits
beyond that. When <n> is negative, display only the beyond that. When <n> is negative, display only the
<reference>s given, without showing the commit ancestry <ref>s given, without showing the commit ancestry tree.
tree.
--list:: --list::
Synonym to `--more=-1` Synonym to `--more=-1`
@ -88,8 +87,8 @@ OPTIONS
the case of three or more commits. the case of three or more commits.
--independent:: --independent::
Among the <reference>s given, display only the ones that Among the <ref>s given, display only the ones that cannot be
cannot be reached from any other <reference>. reached from any other <ref>.
--no-name:: --no-name::
Do not show naming strings for each commit. Do not show naming strings for each commit.
@ -132,10 +131,11 @@ are mutually exclusive.
OUTPUT OUTPUT
------ ------
Given N <references>, the first N lines are the one-line
description from their commit message. The branch head that is Given N <ref>s, the first N lines are the one-line description from
pointed at by $GIT_DIR/HEAD is prefixed with an asterisk `*` their commit message. The branch head that is pointed at by
character while other heads are prefixed with a `!` character. $GIT_DIR/HEAD is prefixed with an asterisk `*` character while other
heads are prefixed with a `!` character.
Following these N lines, one-line log for each commit is Following these N lines, one-line log for each commit is
displayed, indented N places. If a commit is on the I-th displayed, indented N places. If a commit is on the I-th