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

remote: clarify which list of references _ls() returns

Browse Source 
Make it clear that this is not the ls-remote command but a way to access
the data we have and how long it's kept around.
This commit is contained in:
Carlos Martín Nieto 2014-11-19 15:49:02 +01:00
parent 4d86caec59
commit 699dfcc3bc
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
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);
/**
* 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
* memory belongs to the remote.
* Get the list of references with which the server responds to a new
* connection.
*
* The array will stay valid as long as the remote object exists and
* its transport isn't changed, but a copy is recommended for usage of
* the data.
* The remote (or more exactly its transport) must have connected to
* the remote repository. This list is available as soon as the
* 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 size the number of remote heads

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);
if (!remote->transport) {
giterr_set(GITERR_NET, "No transport bound to this remote");
giterr_set(GITERR_NET, "this remote has never connected");
return -1;
}