From: Junio C Hamano Date: Wed, 22 Mar 2023 17:13:15 GMT Subject: Re* [PATCH v2 2/2] Document the output format of ls-remote Message-ID: In-Reply-To: Junio C Hamano writes: > The documentation for "show-branch" uses many s in the > description, which should be updated to match what its SYNOPSIS > section uses, which is . I forgot to list this in the list of actionable items at the end of my review message I am responding to, so here is a patch to help us not forget about it ;-). ----- >8 ----- Subject: show-branch doc: say , not The glossary defines 'ref' as the official name of the thing, and the output from "git grep -e ', not . In addition, the page already says 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 after adding an explanation on how these s are discovered (i.e. we take , , or 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 --- Documentation/git-show-branch.txt | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git c/Documentation/git-show-branch.txt w/Documentation/git-show-branch.txt index 71f608b1ff..0874c01e37 100644 --- c/Documentation/git-show-branch.txt +++ w/Documentation/git-show-branch.txt @@ -74,8 +74,7 @@ OPTIONS that is the common ancestor of all the branches. This flag tells the command to go more common commits beyond that. When is negative, display only the - s given, without showing the commit ancestry - tree. + s given, without showing the commit ancestry tree. --list:: Synonym to `--more=-1` @@ -88,8 +87,8 @@ OPTIONS the case of three or more commits. --independent:: - Among the s given, display only the ones that - cannot be reached from any other . + Among the s given, display only the ones that + cannot be reached from any other . --no-name:: Do not show naming strings for each commit. @@ -132,7 +131,7 @@ are mutually exclusive. OUTPUT ------ -Given N , the first N lines are the one-line +Given N s, the first N lines are the one-line description from their commit message. The branch head that is pointed at by $GIT_DIR/HEAD is prefixed with an asterisk `*` character while other heads are prefixed with a `!` character.