Merge pull request #2717 from libgit2/cmn/remote-ls Clarify the git_remote_ls() documentation
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
diff --git a/include/git2/remote.h b/include/git2/remote.h
index ef24229..4aabd94 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 3715e43..b1a8407 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;
}