Skip to content

Commit 26d9485

Browse files
Denton-Lgitster
authored andcommitted
pretty-options.txt: --notes accepts a ref instead of treeish
Although `--notes=` accepts and handles a tree-ish just fine, it isn't a common use-case for users to pass in bare trees. By having "treeish", it makes it harder to click in users' minds that the argument here is the same type as the `notes.displayRef` configuration variable, for example. Change `treeish` to `ref` so that it will be easier for users to make this connection. Note that we don't completely lose the notion that `--notes=` can accept a tree-ish. In git-notes.txt, we have It is also permitted for a notes ref to point directly to a tree object, in which case the history of the notes can be read with `git log -p -g <refname>`. which means that a hardcore user who wants to take advantage of this obscure use-case will be able to infer the connection and not be completely left in the dark. Signed-off-by: Denton Liu <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 9d45ac4 commit 26d9485

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Documentation/pretty-options.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ message by 4 spaces (i.e. 'medium', which is the default, 'full',
5757
and 'fuller').
5858

5959
ifndef::git-rev-list[]
60-
--notes[=<treeish>]::
60+
--notes[=<ref>]::
6161
Show the notes (see linkgit:git-notes[1]) that annotate the
6262
commit, when showing the commit log message. This is the default
6363
for `git log`, `git show` and `git whatchanged` commands when
@@ -68,8 +68,8 @@ By default, the notes shown are from the notes refs listed in the
6868
`core.notesRef` and `notes.displayRef` variables (or corresponding
6969
environment overrides). See linkgit:git-config[1] for more details.
7070
+
71-
With an optional '<treeish>' argument, use the treeish to find the notes
72-
to display. The treeish can specify the full refname when it begins
71+
With an optional '<ref>' argument, use the ref to find the notes
72+
to display. The ref can specify the full refname when it begins
7373
with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise
7474
`refs/notes/` is prefixed to form a full name of the ref.
7575
+
@@ -85,7 +85,7 @@ being displayed. Examples: "--notes=foo" will show only notes from
8585
"--notes --notes=foo --no-notes --notes=bar" will only show notes
8686
from "refs/notes/bar".
8787

88-
--show-notes[=<treeish>]::
88+
--show-notes[=<ref>]::
8989
--[no-]standard-notes::
9090
These options are deprecated. Use the above --notes/--no-notes
9191
options instead.

0 commit comments

Comments
 (0)