From: Michael J Gruber Date: Thu, 25 Aug 2011 10:26:37 +0000 (+0200) Subject: git-notes.txt: clarify -C vs. copy and -F X-Git-Tag: v1.7.7-rc1~24^2 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=11432bb467c2ba45014fc2fe8c4e23c92b7356d6;p=git.git git-notes.txt: clarify -C vs. copy and -F The current description of '-C' together with the analogy to 'git commit -C' can lead to the wrong conclusion that '-C' copies notes between objects. Make this clearer by rewording and pointing to 'copy'. The example for attaching binary notes with 'git hash-object' followed by 'git notes add -C' immediately raises the question: "Why not use 'git notes add -F'?". Answer it (the latter is not binary-safe). Signed-off-by: Michael J Gruber Acked-by: Johan Herland Signed-off-by: Junio C Hamano --- diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 6a187f2e2..e8319eac6 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -142,8 +142,9 @@ OPTIONS -C :: --reuse-message=:: - 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 ` instead to + copy notes between objects.) -c :: --reedit-message=:: @@ -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.