diff options
| author | Edward Thomson <ethomson@github.com> | 2016-02-22 22:26:01 -0500 |
|---|---|---|
| committer | Edward Thomson <ethomson@github.com> | 2016-02-22 22:26:01 -0500 |
| commit | 5bc93eaea0ce133caab0aa169789f73f0c0bc4ae (patch) | |
| tree | 68072ff794c0e11400b61f6e71569247bae77fff /include/git2/common.h | |
| parent | 305c4f95ce365a68db3895ed6852cd82f7315811 (diff) | |
| download | libgit2-5bc93eaea0ce133caab0aa169789f73f0c0bc4ae.tar.gz | |
git_libgit2_opts: document GIT_OPT_SET_USER_AGENT
Diffstat (limited to 'include/git2/common.h')
| -rw-r--r-- | include/git2/common.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/include/git2/common.h b/include/git2/common.h index ee230dfae..c26030840 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 |