doc: documentation for http.uploadarchive config option
PATCH 1/1 doc: documentation for http.uploadarchive config option
From: Piotr Szlazak <[email protected]>
In Git v2.44.0 support for 'git archive' over HTTP protocol was added, but it was nowhere documented how it should be enabled in git-http-backend.
This commit adds needed information.
---
doc: documentation for http.uploadarchive config option
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1885%2Fpszlazak%2Fdocument-http-uploadarchive-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1885/pszlazak/document-http-uploadarchive-v1
Pull-Request: https://github.com/git/git/pull/1885
Documentation/git-http-backend.txt | 4 ++++ 1 file changed, 4 insertions(+)
Documentation/git-http-backend.txt +4 -0
@@ -56,6 +56,10 @@ http.receivepack:: disabled by setting this item to `false`, or enabled for all users, including anonymous users, by setting it to `true`. +http.uploadarchive:: + This serves 'git archive' clients for remote archive over HTTP/HTTPS + protocols. It is disabled by default. It only works in protocol v2. + URL TRANSLATION --------------- To determine the location of the repository on disk, 'git http-backend'
base-commit: bc204b742735ae06f65bb20291c95985c9633b7f
Signature · 1 line
gitgitgadget
Quoted 5 lines · Piotr Szlazak via GitGitGadget
From: Piotr Szlazak <[email protected]>
In Git v2.44.0 support for 'git archive' over HTTP protocol was added, but it was nowhere documented how it should be enabled in git-http-backend.
Good eyes
Quoted 1 line
This commit adds needed information.
It is more customary to say something like:
Add missing documentation.
around here.
Documentation/git-http-backend.txt http.receivepack:: · line 61
Quoted 11 lines
Documentation/git-http-backend.txt +3
-0@@ -56,6 +56,10 @@ http.receivepack:: disabled by setting this item to `false`, or enabled for all users, including anonymous users, by setting it to `true`. +http.uploadarchive:: + This serves 'git archive' clients for remote archive over HTTP/HTTPS + protocols. It is disabled by default. It only works in protocol v2.
The description looks good, from the correctness point-of-view, and its style is in line with other entries before it.
We may want to later consider moving these four http.* configuration variables somehow to Documentation/config/. directory so that it is shared across git-http-backend.1 and git-config.1 pages, but that is something we should leave outside the current effort.
Thanks.
PATCH v2 1/1 doc: documentation for http.uploadarchive config option
In reply to Piotr Szlazak via GitGitGadgetFrom: Piotr Szlazak <[email protected]>
In Git v2.44.0 support for 'git archive' over HTTP protocol was added, but it was nowhere documented how it should be enabled in git-http-backend.
Add missing documentation.
---
doc: documentation for http.uploadarchive config option
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1885%2Fpszlazak%2Fdocument-http-uploadarchive-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1885/pszlazak/document-http-uploadarchive-v2
Pull-Request: https://github.com/git/git/pull/1885
Range-diff vs v1:
1: 4a5465d0329 ! 1: ace5e71729c doc: documentation for http.uploadarchive config option
@@ Commit message
In Git v2.44.0 support for 'git archive' over HTTP protocol
was added, but it was nowhere documented how it should be
enabled in git-http-backend.
- This commit adds needed information.
+
+ Add missing documentation.
Documentation/git-http-backend.txt | 4 ++++ 1 file changed, 4 insertions(+)
Documentation/git-http-backend.txt +4 -0
@@ -56,6 +56,10 @@ http.receivepack:: disabled by setting this item to `false`, or enabled for all users, including anonymous users, by setting it to `true`. +http.uploadarchive:: + This serves 'git archive' clients for remote archive over HTTP/HTTPS + protocols. It is disabled by default. It only works in protocol v2. + URL TRANSLATION --------------- To determine the location of the repository on disk, 'git http-backend'
base-commit: bc204b742735ae06f65bb20291c95985c9633b7f
Signature · 1 line
gitgitgadget
Quoted 7 lines · Junio C Hamano
Quoted 5 lines · Piotr Szlazak via GitGitGadget
From: Piotr Szlazak <[email protected]>
In Git v2.44.0 support for 'git archive' over HTTP protocol was added, but it was nowhere documented how it should be enabled in git-http-backend.
Quoted 8 lines
Good eyes
Quoted 1 line
This commit adds needed information.
It is more customary to say something like:
Add missing documentation.
around here.
Commit message corrected in [PATCH v2].
Quoted 15 lines
Documentation/git-http-backend.txt http.receivepack:: · line 61
Quoted 12 lines
Documentation/git-http-backend.txt +3
-0@@ -56,6 +56,10 @@ http.receivepack:: disabled by setting this item to `false`, or enabled for all users, including anonymous users, by setting it to `true`. +http.uploadarchive:: + This serves 'git archive' clients for remote archive over HTTP/HTTPS + protocols. It is disabled by default. It only works in protocol v2.The description looks good, from the correctness point-of-view, and its style is in line with other entries before it.
Quoted 6 lines
We may want to later consider moving these four http.* configuration variables somehow to
Documentation/config/. directory so that it is shared across git-http-backend.1 and git-config.1 pages, but that is something we should leave outside the current effort.Thanks.
Regards!