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

[PATCH v2 0/3] A handful of doc synopsis/options update

From
Junio C Hamano <gitster@pobox.com>
Date
May 3, 2025, 01:15 UTC
Message-ID
<20250503011537.3035416-1-gitster@pobox.com>
In-Reply-To
<20250501213414.370514-1-gitster@pobox.com>

Continuing what Jean-Noël started with 22293895 (doc: apply synopsis simplification on git-clone and git-init, 2024-09-24), use more [synopsis] (rather than [verse]) mark-up and also make sure

 - dashed options in the text, including the heading for enumerated
   dashed options in the OPTIONS section, are `backquoted` to be
   typeset verbatim.
 - both positive and negative variants are spelled out when the
   option is negatable, i.e. a heading "--[no-]opt::" is separated
   into "--opt::" and "--no-opt::", to help grep hit with simpler
   patterns.
 - non-options are not described in the OPTIONS section.
The changes in the first two patches are unchanged.

The update to "git daemon" documentation has acquired a bit more `literal` mark-ups, prompted by a comment by Eric Sunshine on the previous iteration.

The initial iteration contained a WIP on worktree documentation, which has been dropped in this iteration.

1:  65a5556d4b = 1:  5e8ae75a6b git-verify-* doc: update mark-up of synopsis option descriptions
2:  a9c5bd63ee = 2:  c6cc44c72b git-{var,write-tree} docs: update mark-up of synopsis option descriptions
3:  eb0e783e21 ! 3:  d424d8c846 git-daemon doc: update mark-up of synopsis option descriptions
    @@ Documentation/git-daemon.adoc: git-daemon - A really simple server for Git repos
      
      DESCRIPTION
      -----------
    +@@ Documentation/git-daemon.adoc: 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
     @@ Documentation/git-daemon.adoc: An `upload-archive` also exists to serve 'git archive'.
      
      OPTIONS
    @@ Documentation/git-daemon.adoc: An `upload-archive` also exists to serve 'git arc
     +`--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
    ++	`git daemon` will refuse to start when this option is enabled and no
      	directory arguments are provided.
      
     ---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
    - 	'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
    +-	'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
Junio C Hamano (3):
  git-verify-* doc: update mark-up of synopsis option descriptions
  git-{var,write-tree} docs: update mark-up of synopsis option
    descriptions
  git-daemon doc: update mark-up of synopsis option descriptions
 Documentation/git-daemon.adoc        | 119 ++++++++++++++-------------
 Documentation/git-var.adoc           |   6 +-
 Documentation/git-verify-commit.adoc |  16 ++--
 Documentation/git-verify-pack.adoc   |  28 +++----
 Documentation/git-verify-tag.adoc    |  16 ++--
 Documentation/git-write-tree.adoc    |  16 ++--
 6 files changed, 97 insertions(+), 104 deletions(-)
-- 
2.49.0-601-ga5925c3955
Previous: Junio C HamanoNext: Junio C Hamano
Message 11 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.