aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2015-10-14 14:30:15 -0700
committerJunio C Hamano <gitster@pobox.com>2015-10-14 14:30:15 -0700
commit262cffe6c9516bc5070e4ee36336a171c425b516 (patch)
treea9338c7db9e3c019cc0e636198769c56a8a3d850 /Documentation
parent4b1fd356b8f8ca464203174a47ab5fa6a5cbc26b (diff)
parente14c92e841fd6d99c8c17af05a411a85ac212254 (diff)
downloadgit-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')
-rw-r--r--Documentation/git-notes.txt4
-rw-r--r--Documentation/pretty-options.txt5
2 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index a9a916f360..8de349968a 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -162,7 +162,9 @@ OPTIONS
--ref <ref>::
Manipulate the notes tree in <ref>. This overrides
'GIT_NOTES_REF' and the "core.notesRef" configuration. The ref
- is taken to be in `refs/notes/` if it is not qualified.
+ 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.
--ignore-missing::
Do not consider it an error to request removing notes from an
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