git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Piotr Szlazak via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org,  Jiang Xin <zhiyou.jx@alibaba-inc.com>,
	 Jeff King <peff@peff.net>,
	 Piotr Szlazak <piotr.szlazak@gmail.com>
Subject: Re: [PATCH] doc: documentation for http.uploadarchive config option
Date: Thu, 06 Feb 2025 06:04:47 -0800	[thread overview]
Message-ID: <xmqqseorjhj4.fsf@gitster.g> (raw)
In-Reply-To: <pull.1885.git.git.1738790425046.gitgitgadget@gmail.com> (Piotr Szlazak via GitGitGadget's message of "Wed, 05 Feb 2025 21:20:24 +0000")

"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.

  reply	other threads:[~2025-02-06 14:04 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-05 21:20 [PATCH] doc: documentation for http.uploadarchive config option Piotr Szlazak via GitGitGadget
2025-02-06 14:04 ` Junio C Hamano [this message]
2025-02-06 17:54   ` Piotr Szlazak
2025-02-06 17:45 ` [PATCH v2] " Piotr Szlazak via GitGitGadget

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqseorjhj4.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=peff@peff.net \
    --cc=piotr.szlazak@gmail.com \
    --cc=zhiyou.jx@alibaba-inc.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).