(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>

diff --git a/notes.h b/notes.h
index 65fc3a66b2f575dd078cc390e7f5ea5cbebffc96..c0288b0d32d5fd63ba691e4d7f272ddb4ae319da 100644 (file)
--- 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.
  * 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,
  */
 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()
  * notes tree) from within the callback:
  * - add_note()
  * - remove_note()

+ * - copy_note()

  * - free_notes()
  */
 typedef int each_note_fn(const unsigned char *object_sha1,
  * - free_notes()
  */
 typedef int each_note_fn(const unsigned char *object_sha1,