(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>
Johan Herland committed
Nov 9, 2010 at 22:49 UTC
55d060771a15f4ce75e71b966d8117d8a32cc47b
1 file changed
+5
notes.h
+5
@@ -104,6 +104,10 @@ const unsigned char *get_note(struct notes_tree *t,
104
* Copy a note from one object to another in the given notes_tree.
105
*
106
* Fails if the to_obj already has a note unless 'force' is true.
107
+ *
108
+ * IMPORTANT: The changes made by copy_note() to the given notes_tree structure
109
+ * are not persistent until a subsequent call to write_notes_tree() returns
110
+ * zero.
111
*/
112
int copy_note(struct notes_tree *t,
113
const unsigned char *from_obj, const unsigned char *to_obj,
@@ -149,6 +153,7 @@ int copy_note(struct notes_tree *t,
153
* notes tree) from within the callback:
154
* - add_note()
155
* - remove_note()
156
+ * - copy_note()
157
* - free_notes()
158
*/
159
typedef int each_note_fn(const unsigned char *object_sha1,