diff options
author | Junio C Hamano <gitster@pobox.com> | 2015-10-14 14:30:15 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2015-10-14 14:30:15 -0700 |
commit | 262cffe6c9516bc5070e4ee36336a171c425b516 (patch) | |
tree | a9338c7db9e3c019cc0e636198769c56a8a3d850 /Documentation/pretty-options.txt | |
parent | git-multimail: update to release 1.2.0 (diff) | |
parent | notes: correct documentation of DWIMery for notes references (diff) | |
download | tgif-262cffe6c9516bc5070e4ee36336a171c425b516.tar.xz |
Merge branch 'jk/notes-dwim-doc'
The way how --ref/--notes to specify the notes tree reference are
DWIMmed was not clearly documented.
* jk/notes-dwim-doc:
notes: correct documentation of DWIMery for notes references
Diffstat (limited to 'Documentation/pretty-options.txt')
-rw-r--r-- | Documentation/pretty-options.txt | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 8d6c5cec4c..4b659ac1a6 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -55,8 +55,9 @@ By default, the notes shown are from the notes refs listed in the environment overrides). See linkgit:git-config[1] for more details. + With an optional '<ref>' argument, show this notes ref instead of the -default notes ref(s). The ref is taken to be in `refs/notes/` if it -is not qualified. +default notes ref(s). The ref specifies the full refname when it begins +with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise +`refs/notes/` is prefixed to form a full name of the ref. + Multiple --notes options can be combined to control which notes are being displayed. Examples: "--notes=foo" will show only notes from |