diff options
author | Carlos Martín Nieto <cmn@dwim.me> | 2014-11-19 15:49:02 +0100 |
---|---|---|
committer | Carlos Martín Nieto <cmn@dwim.me> | 2014-11-19 15:49:02 +0100 |
commit | 699dfcc3bcd4494a1532bf608aa0d84022c58dbf (patch) | |
tree | aa0f55a13f574fcadb6b98dccbb10328f0209755 /include | |
parent | 4d86caec599ab760b523a026040bc4f40f8338c9 (diff) | |
download | libgit2-699dfcc3bcd4494a1532bf608aa0d84022c58dbf.tar.gz |
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.
Diffstat (limited to 'include')
-rw-r--r-- | include/git2/remote.h | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h index ef242293c..d3157d9cc 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 |