Document http options supported by JGit
Change-Id: I0af4f9991fdb4f09de25f743d1e0dca67ceaa18b Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch>
This commit is contained in:
parent
808c4495ca
commit
33a055e63b
|
@ -7,6 +7,8 @@
|
|||
| ✅ | option defined by native git |
|
||||
| ⃞ | jgit custom option not supported by native git |
|
||||
|
||||
For details on native git options see also the official [git config documentation](https://git-scm.com/docs/git-config).
|
||||
|
||||
## __core__ options
|
||||
|
||||
| option | default | git option | description |
|
||||
|
@ -59,6 +61,24 @@
|
|||
| `gc.pruneExpire` | `2.weeks.ago` | ✅ | Grace period after which unreachable objects will be pruned. |
|
||||
| `gc.prunePackExpire` | `1.hour.ago` | ⃞ | Grace period after which packfiles only containing unreachable objects will be pruned. |
|
||||
|
||||
## __http__ options
|
||||
|
||||
| option | default | git option | description |
|
||||
|---------|---------|------------|-------------|
|
||||
| `http.cookieFile`| | ✅ | Absolute path (with tilde expansion) of a cookie file in Netscape format. |
|
||||
| `http.cookieFileCacheLimit`| 10 | ⃞ | JGit caches at most this number of the most recently used cookie files. |
|
||||
| `http.extraHeader`| | ✅ | Extra HTTP header(s) to send with HTTP requests, in the format "`Key: Value`". May appear multiple times; an empty option clears the list. |
|
||||
| `http.followRedirects`| `initial` | ✅ | `true`, `false`, or `initial`. Whether to follow a redirect always, never, or only on the first HTTP request in a git remote operation. |
|
||||
| `http.maxRedirects`| 5 | ⃞ | Maximum number of redirects to follow; can be overridden via the Java system property `http.maxRedirects`. |
|
||||
| `http.postBuffer`| `1 MiB` | ✅ | Maximum size in bytes for single HTTP POST requests; for larger requests, HTTP 1.1 chunked transfer is used. |
|
||||
| `http.saveCookies`| `false` | ✅ | Boolean; if `true` and `http.cookieFile` is set, save received cookies. |
|
||||
| `http.sslVerify`| `true` | ✅ | Boolean; whether to check SSL certificates in HTTPS connections. |
|
||||
| `http.userAgent`| | ✅ | User-agent string to send with HTTP requests. Must be 7bit-ASCII. Can be overridden via environment variable `GIT_HTTP_USER_AGENT`. |
|
||||
|
||||
All `http.*` options can also be specified in a URL-specific way using the format `http.<url>.*`. See the official [git config documentation](https://git-scm.com/docs/git-config#Documentation/git-config.txt-httplturlgt) for details.
|
||||
|
||||
Proxy configuration uses the standard Java mechanisms via class `java.net.ProxySelector`.
|
||||
|
||||
## __pack__ options
|
||||
|
||||
| option | default | git option | description |
|
||||
|
|
Loading…
Reference in New Issue