Skip to content

Commit 78c5be2

Browse files
committed
Merge branch 'mg/maint-notes-C-doc'
* mg/maint-notes-C-doc: git-notes.txt: clarify -C vs. copy and -F
2 parents c63750a + 11432bb commit 78c5be2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Documentation/git-notes.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,9 @@ OPTIONS
142142

143143
-C <object>::
144144
--reuse-message=<object>::
145-
Take the note message from the given blob object (for
146-
example, another note).
145+
Take the given blob object (for example, another note) as the
146+
note message. (Use `git notes copy <object>` instead to
147+
copy notes between objects.)
147148

148149
-c <object>::
149150
--reedit-message=<object>::
@@ -285,6 +286,8 @@ $ blob=$(git hash-object -w a.out)
285286
$ git notes --ref=built add -C "$blob" HEAD
286287
------------
287288

289+
(You cannot simply use `git notes --ref=built add -F a.out HEAD`
290+
because that is not binary-safe.)
288291
Of course, it doesn't make much sense to display non-text-format notes
289292
with 'git log', so if you use such notes, you'll probably need to write
290293
some special-purpose tools to do something useful with them.

0 commit comments

Comments
 (0)