kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

(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>
maint
Johan Herland 2010-11-09 22:49:38 +01:00 committed by Junio C Hamano
parent 327a89dca1
commit 55d060771a
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
notes.h
View File

@ -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. * 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. * 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, int copy_note(struct notes_tree *t,
const unsigned char *from_obj, const unsigned char *to_obj, 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: * notes tree) from within the callback:
* - add_note() * - add_note()
* - remove_note() * - remove_note()
* - copy_note()
* - free_notes() * - free_notes()
*/ */
typedef int each_note_fn(const unsigned char *object_sha1, typedef int each_note_fn(const unsigned char *object_sha1,