From: Junio C Hamano <gitster@pobox.com>
Date: Thu, 01 May 2025 23:12:40 GMT
Subject: Re: [PATCH 3/4] git-daemon doc: update mark-up of synopsis option descriptions
Message-ID: <xmqqa57wvsbb.fsf@gitster.g>
In-Reply-To: <CAPig+cQ1CC2SXN6bViusJXy93jZ6k8UvxRXa6mE0At6FgvS2-Q@mail.gmail.com>

Eric Sunshine <sunshine@sunshineco.com> writes:

>> 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?

Yup, good eyes.

>> ---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?

Probably, so should `git daemon` one line before it.

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

I am not sure what the best mark-up for the sample strings.  They
are not what the end-users are expected to type verbatim, so I've
punted and left them out as in the original ;-)

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

Likewise.