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:22 UTC
Message-ID
<xmqq34dnx6f3.fsf@gitster.g>
In-Reply-To
<xmqqa57wvsbb.fsf@gitster.g>

Here are incremental changes relative to the previous round, taking inspiration from your suggestions.

I think the sample option, sitename, and pathname must be typed verbatim by the readers if the behaviour described in the text is to be reproduced, so changed them in the base-path description all to be marked up as `literal string`.

diff --git c/Documentation/git-daemon.adoc w/Documentation/git-daemon.adoc
index 3eb9332e55..bc3f77405e 100644
--- c/Documentation/git-daemon.adoc
+++ w/Documentation/git-daemon.adoc
@@ -32,7 +32,7 @@ that service if it is enabled.
 It verifies that the directory has the magic file "git-daemon-export-ok", and
 it will refuse to export any Git directory that hasn't explicitly been marked
 for export this way (unless the `--export-all` parameter is specified). If you
-pass some directory paths as 'git daemon' arguments, the offers are limited to
+pass some directory paths as `git daemon` arguments, the offers are limited to
 repositories within those directories.
 
 By default, only `upload-pack` service is enabled, which serves
@@ -49,15 +49,15 @@ OPTIONS
 `--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
+	`git daemon` will refuse to start when this option is enabled and no
 	directory arguments are provided.
 
 `--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
-	'git://example.com/hello.git', 'git daemon' will interpret the path
-	as `/srv/git/hello.git`.
+	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 from `git://example.com/hello.git`, `git daemon` will
+	interpret the path as `/srv/git/hello.git`.
 
 `--base-path-relaxed`::
 	If `--base-path` is enabled and repo lookup fails, with this option
Previous: Junio C HamanoNext: Junio C Hamano
Message 9 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.