Message ID | pull.1885.git.git.1738790425046.gitgitgadget@gmail.com (mailing list archive) |
---|---|
State | Superseded |
Headers | show |
Series | doc: documentation for http.uploadarchive config option | expand |
"Piotr Szlazak via GitGitGadget" <gitgitgadget@gmail.com> writes: > From: Piotr Szlazak <piotr.szlazak@gmail.com> > > 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 > This commit adds needed information. It is more customary to say something like: Add missing documentation. around here. > diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt > index f37ddaded82..1dea4268520 100644 > --- a/Documentation/git-http-backend.txt > +++ b/Documentation/git-http-backend.txt > @@ -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.
On 06.02.2025 15:04, Junio C Hamano wrote: > "Piotr Szlazak via GitGitGadget" <gitgitgadget@gmail.com> writes: > >> From: Piotr Szlazak <piotr.szlazak@gmail.com> >> >> 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 > >> This commit adds needed information. > It is more customary to say something like: > > Add missing documentation. > > around here. Commit message corrected in [PATCH v2]. > >> diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt >> index f37ddaded82..1dea4268520 100644 >> --- a/Documentation/git-http-backend.txt >> +++ b/Documentation/git-http-backend.txt >> @@ -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. Regards!
diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt index f37ddaded82..1dea4268520 100644 --- a/Documentation/git-http-backend.txt +++ b/Documentation/git-http-backend.txt @@ -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'