summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2011-09-02 13:17:40 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2011-09-02 13:17:40 -0700
commit78c5be231bbd58f4deb6ecfabfaff1b2279a4c25 (patch)
tree79ae8912a7aa80ff27e439bc74c300da54889c28
parentMerge branch 'fg/submodule-ff-check-before-push' (diff)
parentgit-notes.txt: clarify -C vs. copy and -F (diff)
downloadtgif-78c5be231bbd58f4deb6ecfabfaff1b2279a4c25.tar.xz
Merge branch 'mg/maint-notes-C-doc'
* mg/maint-notes-C-doc: git-notes.txt: clarify -C vs. copy and -F
-rw-r--r--Documentation/git-notes.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 6a187f2e23..e8319eac69 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -142,8 +142,9 @@ OPTIONS
-C <object>::
--reuse-message=<object>::
- Take the note message from the given blob object (for
- example, another note).
+ Take the given blob object (for example, another note) as the
+ note message. (Use `git notes copy <object>` instead to
+ copy notes between objects.)
-c <object>::
--reedit-message=<object>::
@@ -285,6 +286,8 @@ $ blob=$(git hash-object -w a.out)
$ git notes --ref=built add -C "$blob" HEAD
------------
+(You cannot simply use `git notes --ref=built add -F a.out HEAD`
+because that is not binary-safe.)
Of course, it doesn't make much sense to display non-text-format notes
with 'git log', so if you use such notes, you'll probably need to write
some special-purpose tools to do something useful with them.