From 1a0537e45099054a50e148e5af915a32928705b4 Mon Sep 17 00:00:00 2001 From: nulltoken Date: Wed, 15 Aug 2012 00:08:38 +0200 Subject: [PATCH 1/3] Fix compilation warning --- src/repository.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/repository.c b/src/repository.c index a4eb71876..6f1f4349b 100644 --- a/src/repository.c +++ b/src/repository.c @@ -1095,7 +1095,7 @@ int git_repository_message(char *buffer, size_t len, git_repository *repo) if (buffer == NULL) { git_buf_free(&path); - return st.st_size; + return (int)st.st_size; } if (git_futils_readbuffer(&buf, git_buf_cstr(&path)) < 0) From 5fd17fc2172306dd282b5ac8a040343b8637f252 Mon Sep 17 00:00:00 2001 From: nulltoken Date: Wed, 15 Aug 2012 17:50:02 +0200 Subject: [PATCH 2/3] notes: slight documentation enhancements --- include/git2/notes.h | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/include/git2/notes.h b/include/git2/notes.h index f688f0143..af480a408 100644 --- a/include/git2/notes.h +++ b/include/git2/notes.h @@ -23,10 +23,11 @@ GIT_BEGIN_DECL * * The note must be freed manually by the user. * - * @param note the note; NULL in case of error - * @param repo the Git repository - * @param notes_ref OID reference to use (optional); defaults to "refs/notes/commits" - * @param oid OID of the object + * @param note pointer to the read note; NULL in case of error + * @param repo repository where to look up the note + * @param notes_ref canonical name of the reference to use (optional); + * defaults to "refs/notes/commits" + * @param oid OID of the git object to read the note from * * @return 0 or an error code */ @@ -50,17 +51,17 @@ GIT_EXTERN(const char *) git_note_message(git_note *note); */ GIT_EXTERN(const git_oid *) git_note_oid(git_note *note); - /** * Add a note for an object * * @param out pointer to store the OID (optional); NULL in case of error - * @param repo the Git repository + * @param repo repository where to store the note * @param author signature of the notes commit author * @param committer signature of the notes commit committer - * @param notes_ref OID reference to update (optional); defaults to "refs/notes/commits" - * @param oid The OID of the object - * @param note The note to add for object oid + * @param notes_ref canonical name of the reference to use (optional); + * defaults to "refs/notes/commits" + * @param oid OID of the git object to decorate + * @param note Content of the note to add for object oid * * @return 0 or an error code */ @@ -73,11 +74,12 @@ GIT_EXTERN(int) git_note_create(git_oid *out, git_repository *repo, /** * Remove the note for an object * - * @param repo the Git repository - * @param notes_ref OID reference to use (optional); defaults to "refs/notes/commits" + * @param repo repository where the note lives + * @param notes_ref canonical name of the reference to use (optional); + * defaults to "refs/notes/commits" * @param author signature of the notes commit author * @param committer signature of the notes commit committer - * @param oid The OID of the git object to remove the note from + * @param oid OID of the git object to remove the note from * * @return 0 or an error code */ From e0db9f1117197deb9d948976f901d20d04a5d1c4 Mon Sep 17 00:00:00 2001 From: nulltoken Date: Wed, 15 Aug 2012 17:54:05 +0200 Subject: [PATCH 3/3] refs: fix missing parameter documentation --- include/git2/refs.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/git2/refs.h b/include/git2/refs.h index d92390061..9e7060075 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -335,6 +335,8 @@ GIT_EXTERN(int) git_reference_cmp(git_reference *ref1, git_reference *ref2); * * @param repo Repository where to find the references. * + * @param glob Glob pattern references should match. + * * @param list_flags Filtering flags for the reference * listing. *