Commit 55d06077 authored by Johan Herland's avatar Johan Herland Committed by Junio C Hamano

(trivial) notes.h: Minor documentation fixes to copy_notes()

Signed-off-by: default avatarJohan Herland <[email protected]>
Signed-off-by: default avatarJunio C Hamano <[email protected]>
parent 327a89dc
......@@ -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,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment