From 3f0e3e166218b875a3e011c790311fc5c50047d1 Mon Sep 17 00:00:00 2001 From: Arthur Schreiber Date: Thu, 16 Jan 2014 21:42:28 +0100 Subject: [PATCH 1/2] Fix some documentation issues. --- include/git2/refs.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/include/git2/refs.h b/include/git2/refs.h index e4c6f1b16..a568b9cde 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -27,7 +27,7 @@ GIT_BEGIN_DECL * The returned reference must be freed by the user. * * The name will be checked for validity. - * See `git_reference_create_symbolic()` for rules about valid names. + * See `git_reference_symbolic_create()` for rules about valid names. * * @param out pointer to the looked-up reference * @param repo the repository to look up the reference @@ -91,7 +91,7 @@ GIT_EXTERN(int) git_reference_dwim(git_reference **out, git_repository *repo, co * * The signature and message for the reflog will be ignored if the * reference does not belong in the standard set (HEAD, branches and - * remote-tracking branches) and and it does not have a reflog. + * remote-tracking branches) or it does not have a reflog. * * @param out Pointer to the newly created reference * @param repo Repository where that reference will live @@ -192,7 +192,7 @@ GIT_EXTERN(git_ref_t) git_reference_type(const git_reference *ref); /** * Get the full name of a reference. * - * See `git_reference_create_symbolic()` for rules about valid names. + * See `git_reference_symbolic_create()` for rules about valid names. * * @param ref The reference * @return the full name for the ref @@ -233,7 +233,7 @@ GIT_EXTERN(git_repository *) git_reference_owner(const git_reference *ref); * The new reference will be written to disk, overwriting the given reference. * * The target name will be checked for validity. - * See `git_reference_create_symbolic()` for rules about valid names. + * See `git_reference_symbolic_create()` for rules about valid names. * * The signature and message for the reflog will be ignored if the * reference does not belong in the standard set (HEAD, branches and @@ -284,7 +284,7 @@ GIT_EXTERN(int) git_reference_set_target( * This method works for both direct and symbolic references. * * The new name will be checked for validity. - * See `git_reference_create_symbolic()` for rules about valid names. + * See `git_reference_symbolic_create()` for rules about valid names. * * If the `force` flag is not enabled, and there's already * a reference with the given name, the renaming will fail. @@ -544,7 +544,7 @@ typedef enum { * Once normalized, if the reference name is valid, it will be returned in * the user allocated buffer. * - * See `git_reference_create_symbolic()` for rules about valid names. + * See `git_reference_symbolic_create()` for rules about valid names. * * @param buffer_out User allocated buffer to store normalized name * @param buffer_size Size of buffer_out From 3f033c55950f5ebdb00c6628eaff7583b50b90b3 Mon Sep 17 00:00:00 2001 From: Arthur Schreiber Date: Thu, 16 Jan 2014 21:53:25 +0100 Subject: [PATCH 2/2] Revert a wrong doc change. --- include/git2/refs.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/git2/refs.h b/include/git2/refs.h index a568b9cde..b203f242b 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -91,7 +91,7 @@ GIT_EXTERN(int) git_reference_dwim(git_reference **out, git_repository *repo, co * * The signature and message for the reflog will be ignored if the * reference does not belong in the standard set (HEAD, branches and - * remote-tracking branches) or it does not have a reflog. + * remote-tracking branches) and it does not have a reflog. * * @param out Pointer to the newly created reference * @param repo Repository where that reference will live