summaryrefslogtreecommitdiff
path: root/notes.h
diff options
context:
space:
mode:
authorJohan Herland <johan@herland.net>2010-11-09 22:49:38 +0100
committerJunio C Hamano <gitster@pobox.com>2010-11-10 10:25:51 -0800
commit55d060771a15f4ce75e71b966d8117d8a32cc47b (patch)
treef7c45ec842cf2baf89eab44ce34095d7925bb27e /notes.h
parent327a89dca11ac78aee711e4ab440d2194b9914f8 (diff)
downloadgit-55d060771a15f4ce75e71b966d8117d8a32cc47b.tar.gz
(trivial) notes.h: Minor documentation fixes to copy_notes()
Signed-off-by: Johan Herland <johan@herland.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'notes.h')
-rw-r--r--notes.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/notes.h b/notes.h
index 65fc3a66b2..c0288b0d32 100644
--- a/notes.h
+++ b/notes.h
@@ -104,6 +104,10 @@ const unsigned char *get_note(struct notes_tree *t,
* Copy a note from one object to another in the given notes_tree.
*
* Fails if the to_obj already has a note unless 'force' is true.
+ *
+ * IMPORTANT: The changes made by copy_note() to the given notes_tree structure
+ * are not persistent until a subsequent call to write_notes_tree() returns
+ * zero.
*/
int copy_note(struct notes_tree *t,
const unsigned char *from_obj, const unsigned char *to_obj,
@@ -149,6 +153,7 @@ int copy_note(struct notes_tree *t,
* notes tree) from within the callback:
* - add_note()
* - remove_note()
+ * - copy_note()
* - free_notes()
*/
typedef int each_note_fn(const unsigned char *object_sha1,