[PATCH] notes: document behavior of --ref and --notes DWIMery
- From
Jacob Keller <jacob.e.keller@intel.com>
- Date
- Sep 22, 2015, 20:24 UTC
- Message-ID
- <1442953476-24537-1-git-send-email-jacob.e.keller@intel.com>
From: Jacob Keller <jacob.keller@gmail.com>
The --notes and --ref parameter for selecting which notes ref to operate on are based off of expand_notes_ref functionality. The documentation mentioned that an unqualified ref argument would be taken as under `refs/notes/`. However, this does not clearly indicate that `refs/heads/master` will expand to `refs/notes/refs/heads/master`, so document this behavior.
Add a further test for the expected behavior of git notes --ref refs/heads/master get-ref as well, to ensure future patches do not break this assumption.
Signed-off-by: Jacob Keller <jacob.keller@gmail.com> --- Documentation/git-notes.txt | 4 +++- Documentation/pretty-options.txt | 5 +++-- t/t3301-notes.sh | 6 ++++++ 3 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index a9a916f360ec..2ed9c16a1aac 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. + is taken to be in `refs/notes/` even if it is qualified under some + other location; in other words, `refs/heads/master` will be expanded + to `refs/notes/refs/heads/master`. --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 8d6c5cec4c5e..abcb787e7149 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 is taken to be in `refs/notes/` even if it is +qualified under some other location; in other words, `refs/heads/master` +will be expanded to `refs/notes/refs/heads/master`. + Multiple --notes options can be combined to control which notes are being displayed. Examples: "--notes=foo" will show only notes from diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh index 06b45847c147..2d200fdf36c6 100755 --- a/t/t3301-notes.sh +++ b/t/t3301-notes.sh @@ -1132,6 +1132,12 @@ test_expect_success 'git notes copy diagnoses too many or too few parameters' ' test_must_fail git notes copy one two three ' +test_expect_success 'git notes get-ref expands refs/heads/master to refs/notes/refs/heads/master' ' + test_unconfig core.notesRef && + sane_unset GIT_NOTES_REF && + test "$(git notes --ref=refs/heads/master get-ref)" = "refs/notes/refs/heads/master" +' + test_expect_success 'git notes get-ref (no overrides)' ' test_unconfig core.notesRef && sane_unset GIT_NOTES_REF &&
-- 2.6.0.rc3.238.gc07a1e8