transport: document ssh-agent authentication

1 files changed, 12 insertions, 0 deletions

diff --git a/include/git2/transport.h b/include/git2/transport.h
index caabd0465..039321088 100644
--- a/include/git2/transport.h
+++ b/include/git2/transport.h
@@ -131,6 +131,18 @@ GIT_EXTERN(int) git_cred_ssh_key_new(
 	const char *passphrase);
 
 /**
+ * Create a new ssh key credential object used for querying an ssh-agent.
+ * The supplied credential parameter will be internally duplicated.
+ *
+ * @param out The newly created credential object.
+ * @param username username to use to authenticate
+ * @return 0 for success or an error code for failure
+ */
+GIT_EXTERN(int) git_cred_ssh_key_from_agent(
+	git_cred **out,
+	const char *username);
+
+/**
  * Create an ssh key credential with a custom signing function.
  *
  * This lets you use your own function to sign the challenge.