proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-06-22 18:37:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #3315 from rcorre/docfix

Browse Source 
Document git_fetch_options struct and fix typo.
This commit is contained in:
Carlos Martín Nieto 2015-07-20 16:47:21 +02:00
commit 42156d5617
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/git2/remote.h
View File

@ -511,6 +511,14 @@ typedef enum {
GIT_REMOTE_DOWNLOAD_TAGS_ALL, GIT_REMOTE_DOWNLOAD_TAGS_ALL,
} git_remote_autotag_option_t; } 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 { typedef struct {
int version; 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 * stored here for further processing by the caller. Always free this
* strarray on successful return. * strarray on successful return.
* @param repo the repository in which to rename * @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 * @param new_name the new name the remote should bear
* @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
*/ */