git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Junio C Hamano <gitster@pobox.com>
Date
May 1, 2025, 23:12 UTC
Message-ID
<xmqqa57wvsbb.fsf@gitster.g>
In-Reply-To
<CAPig+cQ1CC2SXN6bViusJXy93jZ6k8UvxRXa6mE0At6FgvS2-Q@mail.gmail.com>
Eric Sunshine <sunshine@sunshineco.com> writes:
Show 10 quoted lines
>> 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.
Show 7 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?
Probably, so should `git daemon` one line before it.
Show 5 quoted lines
>>         '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 ;-)

Show 8 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.
Likewise.
Previous: Eric SunshineNext: Junio C Hamano
Message 8 of 26 in “A handful of doc synopsis/options update”
  1. 0/4 A handful of doc synopsis/options updateJunio C Hamano, May 1, 2025
  2. 1/4 git-verify-* doc: update mark-up of synopsis option descriptionsJunio C Hamano, May 1, 2025
  3. Eric SunshineMay 1, 2025
  4. Junio C HamanoMay 1, 2025
  5. 2/4 git-{var,write-tree} docs: update mark-up of synopsis option descriptionsJunio C Hamano, May 1, 2025
  6. 3/4 git-daemon doc: update mark-up of synopsis option descriptionsJunio C Hamano, May 1, 2025
  7. Eric SunshineMay 1, 2025
  8. Junio C HamanoMay 1, 2025
  9. Junio C HamanoMay 1, 2025
  10. 4/4 git-worktree doc: update mark-up of synopsis option descriptionsJunio C Hamano, May 1, 2025
  11. 0/3 A handful of doc synopsis/options updateJunio C Hamano, May 3, 2025
  12. 1/3 git-verify-* doc: update mark-up of synopsis option descriptionsJunio C Hamano, May 3, 2025
  13. 2/3 git-{var,write-tree} docs: update mark-up of synopsis option descriptionsJunio C Hamano, May 3, 2025
  14. 3/3 git-daemon doc: update mark-up of synopsis option descriptionsJunio C Hamano, May 3, 2025
  15. Additional changesJean-Noël Avila, May 7, 2025
  16. Additional changesJean-Noël Avila, May 7, 2025
  17. Junio C HamanoMay 8, 2025
  18. Jean-Noël AVILAMay 9, 2025
  19. Junio C HamanoMay 9, 2025
  20. Jean-Noël AVILAMay 9, 2025
  21. Junio C HamanoMay 9, 2025
  22. 0/4 Additional changesJean-Noël Avila, May 10, 2025
  23. 1/4 git-daemon doc: update mark-up of synopsis option descriptionsJean-Noël Avila, May 10, 2025
  24. 2/4 git-{var,write-tree} docs: update mark-up of synopsis option descriptionsJean-Noël Avila, May 10, 2025
  25. 3/4 git-verify-* doc: update mark-up of synopsis option descriptionsJean-Noël Avila, May 10, 2025
  26. 4/4 git-var doc: fix usage of $ENV_VAR vs ENV_VARJean-Noël Avila, May 10, 2025

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.