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

Merge pull request #2717 from libgit2/cmn/remote-ls

Browse Source 
Clarify the git_remote_ls() documentation
This commit is contained in:
Vicent Marti 2014-11-20 13:12:49 +01:00
commit fd10b110de
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
include/git2/remote.h
View File

@ -281,14 +281,19 @@ GIT_EXTERN(const git_refspec *)git_remote_get_refspec(const git_remote *remote,
GIT_EXTERN(int) git_remote_connect(git_remote *remote, git_direction direction); GIT_EXTERN(int) git_remote_connect(git_remote *remote, git_direction direction);
/** /**
* Get a list of refs at the remote * Get the remote repository's reference advertisement list
* *
* The remote (or more exactly its transport) must be connected. The * Get the list of references with which the server responds to a new
* memory belongs to the remote. * connection.
* *
* The array will stay valid as long as the remote object exists and * The remote (or more exactly its transport) must have connected to
* its transport isn't changed, but a copy is recommended for usage of * the remote repository. This list is available as soon as the
* the data. * connection to the remote is initiated and it remains available
* after disconnecting.
*
* The memory belongs to the remote. The pointer will be valid as long
* as a new connection is not initiated, but it is recommended that
* you make a copy in order to make use of the data.
* *
* @param out pointer to the array * @param out pointer to the array
* @param size the number of remote heads * @param size the number of remote heads
@ -338,8 +343,7 @@ GIT_EXTERN(void) git_remote_stop(git_remote *remote);
/** /**
* Disconnect from the remote * Disconnect from the remote
* *
* Close the connection to the remote and free the underlying * Close the connection to the remote.
* transport.
* *
* @param remote the remote to disconnect from * @param remote the remote to disconnect from
*/ */

2
src/remote.c
View File

@ -706,7 +706,7 @@ int git_remote_ls(const git_remote_head ***out, size_t *size, git_remote *remote
assert(remote); assert(remote);
if (!remote->transport) { if (!remote->transport) {
giterr_set(GITERR_NET, "No transport bound to this remote"); giterr_set(GITERR_NET, "this remote has never connected");
return -1; return -1;
} }