diff options
| author | Jacob Keller <jacob.keller@gmail.com> | 2015-09-22 15:15:03 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-09-22 15:24:01 -0700 |
| commit | e14c92e841fd6d99c8c17af05a411a85ac212254 (patch) | |
| tree | 7f8ec8f99501d78fe43bcdc5882c30f745c9ff1c /Documentation/git-notes.txt | |
| parent | ee6ad5f4d56e697c972af86cbefdf269b386e470 (diff) | |
| download | git-e14c92e841fd6d99c8c17af05a411a85ac212254.tar.gz | |
notes: correct documentation of DWIMery for notes referencesjk/notes-dwim-doc
expand_notes_ref is used by --ref from git-notes(1) and --notes from the
git log to find the full refname of a notes reference. Previously the
documentation of these options was not clear about what sorts of
expansions would be performed. Fix the documentation to clearly and
accurately describe the behavior of the expansions.
Add a test for this expansion when using git notes get-ref in order to
prevent future patches from changing this behavior.
Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-notes.txt')
| -rw-r--r-- | Documentation/git-notes.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 851518d531..b8889ecf1c 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 |