Commit 5bc93eaea0ce133caab0aa169789f73f0c0bc4ae

Edward Thomson 2016-02-22T22:26:01

git_libgit2_opts: document GIT_OPT_SET_USER_AGENT

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/git2/common.h b/include/git2/common.h
index ee230df..c260308 100644
--- a/include/git2/common.h
+++ b/include/git2/common.h
@@ -245,6 +245,12 @@ typedef enum {
  *
  *	* opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)
  *
+ *		> Set the value of the User-Agent header.  This value will be
+ *		> appended to "git/1.0", for compatibility with other git clients.
+ *		>
+ *		> - `user_agent` is the value that will be delivered as the
+ *		>   User-Agent header on HTTP requests.
+ *
  * @param option Option key
  * @param ... value to set the option
  * @return 0 on success, <0 on failure