Re: [PATCH 3/4] git-daemon doc: update mark-up of synopsis option descriptions

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 1, 2025, 22:52 UTC
Message-ID: <CAPig+cQ1CC2SXN6bViusJXy93jZ6k8UvxRXa6mE0At6FgvS2-Q@mail.gmail.com>
In-Reply-To: <20250501213414.370514-4-gitster@pobox.com>

On Thu, May 1, 2025 at 5:34 PM Junio C Hamano <gitster@pobox.com> wrote:

Show 21 quoted lines

> To unify mark-up used in our documentation to a newer convention,
> started by 22293895 (doc: apply synopsis simplification on git-clone
> and git-init, 2024-09-24), update the documentation of 'git daemon'
> to
>
>  * use [synopsis], not [verse] in the SYNOPSIS section
>  * enclose `--option=<value>` in backquotes
>
> Also, split '--[no-]option' into '--option' and '--no-option'
> to make it easier to grep for them.
>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
> diff --git a/Documentation/git-daemon.adoc b/Documentation/git-daemon.adoc
> @@ -46,26 +46,26 @@ An `upload-archive` also exists to serve 'git archive'.
> ---strict-paths::
> +`--strict-paths`::
>         Match paths exactly (i.e. don't allow "/foo/repo" when the real path is
>         "/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths.
>         'git daemon' will refuse to start when this option is enabled and no
>         directory arguments are provided.

Should 'git daemon' be wrapped in backticks instead?

Show 5 quoted lines

> ---base-path=<path>::
> +`--base-path=<path>`::
>         Remap all the path requests as relative to the given path.
>         This is sort of "Git root" - if you run 'git daemon' with
>         '--base-path=/srv/git' on example.com, then if you later try to pull

Should the '--base-path=/srv/git' example be wrapped in backticks instead?

>         'git://example.com/hello.git', 'git daemon' will interpret the path
>         as `/srv/git/hello.git`.

These are inconsistent, as well: the first two use apostrophes, and the latter backticks.

Show 6 quoted lines

> @@ -135,8 +135,8 @@ none::
> +`--user-path`::
> +`--user-path=<path>`::
>         Allow {tilde}user notation to be used in requests.  When
>         specified with no parameter, a request to
>         git://host/{tilde}alice/foo is taken as a request to access

And this URL has no quoting.