[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 descriptionsDocumentation/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