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

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

From
Junio C Hamano <gitster@pobox.com>
Date
May 1, 2025, 21:34 UTC
Message-ID
<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 "git worktree" one is a bit unsatisfactory and should be considered WIP.

Junio C Hamano (4):
  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
  git-worktree doc: update mark-up of synopsis option descriptions
 Documentation/git-daemon.adoc        | 107 ++++++++++++++-------------
 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-worktree.adoc      |  71 +++++++++---------
 Documentation/git-write-tree.adoc    |  16 ++--
 7 files changed, 129 insertions(+), 131 deletions(-)
-- 
2.49.0-599-g90c2cffacf
Next: Junio C Hamano
Message 1 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.