diff options
author | Vicent Marti <vicent@github.com> | 2014-11-20 13:12:49 +0100 |
---|---|---|
committer | Vicent Marti <vicent@github.com> | 2014-11-20 13:12:49 +0100 |
commit | fd10b110deb3c7cc5444b52b0c7fc8fe7f3e295c (patch) | |
tree | aae3f39a5f4d705719a9eb8c2a58227cbc63e4cf | |
parent | 21361cb7feebdf4622f496a9717fe3af032cbe39 (diff) | |
parent | 8fd7dd778ddc2aa157de6a3b307a9c2b3686fe7a (diff) | |
download | libgit2-fd10b110deb3c7cc5444b52b0c7fc8fe7f3e295c.tar.gz |
Merge pull request #2717 from libgit2/cmn/remote-ls
Clarify the git_remote_ls() documentation
-rw-r--r-- | include/git2/remote.h | 20 | ||||
-rw-r--r-- | src/remote.c | 2 |
2 files changed, 13 insertions, 9 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h index ef242293c..4aabd94b6 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -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 @@ -338,8 +343,7 @@ GIT_EXTERN(void) git_remote_stop(git_remote *remote); /** * Disconnect from the remote * - * Close the connection to the remote and free the underlying - * transport. + * Close the connection to the remote. * * @param remote the remote to disconnect from */ diff --git a/src/remote.c b/src/remote.c index 3715e43ea..b1a84075e 100644 --- a/src/remote.c +++ b/src/remote.c @@ -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; } |