From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 3/4] git-daemon doc: update mark-up of synopsis option descriptions
Date: Thu, 01 May 2025 16:12:40 -0700 [thread overview]
Message-ID: <xmqqa57wvsbb.fsf@gitster.g> (raw)
In-Reply-To: <CAPig+cQ1CC2SXN6bViusJXy93jZ6k8UvxRXa6mE0At6FgvS2-Q@mail.gmail.com> (Eric Sunshine's message of "Thu, 1 May 2025 18:52:09 -0400")
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.
next prev parent reply other threads:[~2025-05-01 23:12 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-01 21:34 [PATCH 0/4] A handful of doc synopsis/options update Junio C Hamano
2025-05-01 21:34 ` [PATCH 1/4] git-verify-* doc: update mark-up of synopsis option descriptions Junio C Hamano
2025-05-01 22:43 ` Eric Sunshine
2025-05-01 23:10 ` Junio C Hamano
2025-05-01 21:34 ` [PATCH 2/4] git-{var,write-tree} docs: " Junio C Hamano
2025-05-01 21:34 ` [PATCH 3/4] git-daemon doc: " Junio C Hamano
2025-05-01 22:52 ` Eric Sunshine
2025-05-01 23:12 ` Junio C Hamano [this message]
2025-05-01 23:22 ` Junio C Hamano
2025-05-01 21:34 ` [WIP PATCH 4/4] git-worktree " Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 0/3] A handful of doc synopsis/options update Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 1/3] git-verify-* doc: update mark-up of synopsis option descriptions Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 2/3] git-{var,write-tree} docs: " Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 3/3] git-daemon doc: " Junio C Hamano
2025-05-07 20:58 ` Additional changes Jean-Noël Avila
2025-05-07 20:58 ` [PATCH] " Jean-Noël Avila
2025-05-08 15:14 ` Junio C Hamano
2025-05-09 12:12 ` Jean-Noël AVILA
2025-05-09 14:35 ` Junio C Hamano
2025-05-09 17:08 ` Jean-Noël AVILA
2025-05-09 18:24 ` Junio C Hamano
2025-05-10 12:33 ` [PATCH v3 0/4] " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 1/4] git-daemon doc: update mark-up of synopsis option descriptions Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 2/4] git-{var,write-tree} docs: " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 3/4] git-verify-* doc: " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 4/4] git-var doc: fix usage of $ENV_VAR vs ENV_VAR Jean-Noël Avila
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=xmqqa57wvsbb.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=sunshine@sunshineco.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.