Commit 699dfcc3 by Carlos Martín Nieto

remote: clarify which list of references _ls() returns

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.
parent 4d86caec
...@@ -281,14 +281,19 @@ GIT_EXTERN(const git_refspec *)git_remote_get_refspec(const git_remote *remote, ...@@ -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
......
...@@ -706,7 +706,7 @@ int git_remote_ls(const git_remote_head ***out, size_t *size, git_remote *remote ...@@ -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;
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment