From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Subject: [PATCH 0/4] A handful of doc synopsis/options update
Date: Thu, 1 May 2025 14:34:10 -0700 [thread overview]
Message-ID: <20250501213414.370514-1-gitster@pobox.com> (raw)
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 reply other threads:[~2025-05-01 21:34 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-01 21:34 Junio C Hamano [this message]
2025-05-01 21:34 ` [PATCH 1/4] git-verify-* doc: update mark-up of synopsis option descriptions Junio C Hamano
2025-05-01 22:43 ` Eric Sunshine
2025-05-01 23:10 ` Junio C Hamano
2025-05-01 21:34 ` [PATCH 2/4] git-{var,write-tree} docs: " Junio C Hamano
2025-05-01 21:34 ` [PATCH 3/4] git-daemon doc: " Junio C Hamano
2025-05-01 22:52 ` Eric Sunshine
2025-05-01 23:12 ` Junio C Hamano
2025-05-01 23:22 ` Junio C Hamano
2025-05-01 21:34 ` [WIP PATCH 4/4] git-worktree " Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 0/3] A handful of doc synopsis/options update Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 1/3] git-verify-* doc: update mark-up of synopsis option descriptions Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 2/3] git-{var,write-tree} docs: " Junio C Hamano
2025-05-03 1:15 ` [PATCH v2 3/3] git-daemon doc: " Junio C Hamano
2025-05-07 20:58 ` Additional changes Jean-Noël Avila
2025-05-07 20:58 ` [PATCH] " Jean-Noël Avila
2025-05-08 15:14 ` Junio C Hamano
2025-05-09 12:12 ` Jean-Noël AVILA
2025-05-09 14:35 ` Junio C Hamano
2025-05-09 17:08 ` Jean-Noël AVILA
2025-05-09 18:24 ` Junio C Hamano
2025-05-10 12:33 ` [PATCH v3 0/4] " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 1/4] git-daemon doc: update mark-up of synopsis option descriptions Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 2/4] git-{var,write-tree} docs: " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 3/4] git-verify-* doc: " Jean-Noël Avila
2025-05-10 12:33 ` [PATCH v3 4/4] git-var doc: fix usage of $ENV_VAR vs ENV_VAR Jean-Noël Avila
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250501213414.370514-1-gitster@pobox.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).