proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-05 15:33:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

remote: Improve documentation

Browse Source
This commit is contained in:
nulltoken 2012-12-24 15:29:26 +01:00
parent b0aa14aa3c
commit ae35aa0708
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/git2/remote.h
View File

@ -41,7 +41,7 @@ typedef int (*git_remote_rename_problem_cb)(const char *problematic_refspec, voi
* @param repo the repository in which to create the remote * @param repo the repository in which to create the remote
* @param name the remote's name * @param name the remote's name
* @param url the remote's url * @param url the remote's url
* @return 0 or an error code * @return 0, GIT_EINVALIDSPEC or an error code
*/ */
GIT_EXTERN(int) git_remote_create( GIT_EXTERN(int) git_remote_create(
git_remote **out, git_remote **out,
@ -63,7 +63,7 @@ GIT_EXTERN(int) git_remote_create(
* @param repo the associated repository. May be NULL for a "dangling" remote. * @param repo the associated repository. May be NULL for a "dangling" remote.
* @param url the remote repository's URL * @param url the remote repository's URL
* @param fetch the fetch refspec to use for this remote. May be NULL for defaults. * @param fetch the fetch refspec to use for this remote. May be NULL for defaults.
* @return 0, GIT_EINVALIDSPEC or an error code * @return 0 or an error code
*/ */
GIT_EXTERN(int) git_remote_create_inmemory( GIT_EXTERN(int) git_remote_create_inmemory(
git_remote **out, git_remote **out,
@ -97,7 +97,7 @@ GIT_EXTERN(int) git_remote_load(git_remote **out, git_repository *repo, const ch
/** /**
* Save a remote to its repository's configuration * Save a remote to its repository's configuration
* *
* One can't save a nameless inmemory remote. Doing so will * One can't save a in-memory remote. Doing so will
* result in a GIT_EINVALIDSPEC being returned. * result in a GIT_EINVALIDSPEC being returned.
* *
* @param remote the remote to save to config * @param remote the remote to save to config
@ -428,12 +428,14 @@ GIT_EXTERN(void) git_remote_set_autotag(
* The new name will be checked for validity. * The new name will be checked for validity.
* See `git_tag_create()` for rules about valid names. * See `git_tag_create()` for rules about valid names.
* *
* A temporary in-memory remote cannot be given a name with this method.
*
* @param remote the remote to rename * @param remote the remote to rename
* @param new_name the new name the remote should bear * @param new_name the new name the remote should bear
* @param callback Optional callback to notify the consumer of fetch refspecs * @param callback Optional callback to notify the consumer of fetch refspecs
* that haven't been automatically updated and need potential manual tweaking. * that haven't been automatically updated and need potential manual tweaking.
* @param payload Additional data to pass to the callback * @param payload Additional data to pass to the callback
* @return 0, GIT_EINVALIDSPEC or an error code * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
*/ */
GIT_EXTERN(int) git_remote_rename( GIT_EXTERN(int) git_remote_rename(
git_remote *remote, git_remote *remote,