From 55d060771a15f4ce75e71b966d8117d8a32cc47b Mon Sep 17 00:00:00 2001 From: Johan Herland Date: Tue, 9 Nov 2010 22:49:38 +0100 Subject: (trivial) notes.h: Minor documentation fixes to copy_notes() Signed-off-by: Johan Herland Signed-off-by: Junio C Hamano --- notes.h | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'notes.h') 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, -- cgit v1.2.3