diff options
author | Carlos Martín Nieto <cmn@dwim.me> | 2015-07-20 16:47:21 +0200 |
---|---|---|
committer | Carlos Martín Nieto <cmn@dwim.me> | 2015-07-20 16:47:21 +0200 |
commit | 42156d561723e92ffe597885719aa63abfe0795c (patch) | |
tree | 3ca88342eb9710643fab3a8c355ce73e77382948 | |
parent | 274f0b9371d26a2e65a7d8842978dc92562b4c34 (diff) | |
parent | 37996d474b658f7428b2195023da82a9b480f307 (diff) | |
download | libgit2-42156d561723e92ffe597885719aa63abfe0795c.tar.gz |
Merge pull request #3315 from rcorre/docfix
Document git_fetch_options struct and fix typo.
-rw-r--r-- | include/git2/remote.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h index e47f00881..444fe5276 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -511,6 +511,14 @@ typedef enum { GIT_REMOTE_DOWNLOAD_TAGS_ALL, } git_remote_autotag_option_t; +/** + * Fetch options structure. + * + * Zero out for defaults. Initialize with `GIT_FETCH_OPTIONS_INIT` macro to + * correctly set the `version` field. E.g. + * + * git_fetch_options opts = GIT_FETCH_OPTIONS_INIT; + */ typedef struct { int version; @@ -739,7 +747,7 @@ GIT_EXTERN(int) git_remote_prune_refs(const git_remote *remote); * stored here for further processing by the caller. Always free this * strarray on successful return. * @param repo the repository in which to rename - * @param name the current name of the reamote + * @param name the current name of the remote * @param new_name the new name the remote should bear * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code */ |