summaryrefslogtreecommitdiff
path: root/include/git2/remote.h
diff options
context:
space:
mode:
authorjoshaber <joshaber@gmail.com>2015-07-22 11:33:18 -0400
committerjoshaber <joshaber@gmail.com>2015-07-22 11:33:18 -0400
commit9830fbba05ef66325f929a09407abc45ab85847d (patch)
treedac363428f4705a632719e03b8b77f2d32ce2bb3 /include/git2/remote.h
parentcf198fdf2a044d2e2f0675c2c6b1cd9cdbcf4fcf (diff)
parent42156d561723e92ffe597885719aa63abfe0795c (diff)
downloadlibgit2-fix-init-ordering.tar.gz
Merge branch 'master' into fix-init-orderingfix-init-ordering
Diffstat (limited to 'include/git2/remote.h')
-rw-r--r--include/git2/remote.h10
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
*/