From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>,
"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH v2 0/4] doc: some more synopsis conversions and fixes
Date: Mon, 26 Jan 2026 21:25:40 +0000 [thread overview]
Message-ID: <pull.2036.v2.git.1769462744.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.2036.git.1769202903.gitgitgadget@gmail.com>
This time, git-show and git-submodule are converted. Some mistakes on
previous work were also spotted and fixed.
Changes since V1:
* fix mistakes spotted by Kristoffer Haugsbakk
Jean-Noël Avila (4):
convert git-submodule doc to synopsis style
doc: finalize git-clone documentation conversion to synopsis style
doc: fix some style issues in git-clone and for-each-ref-options
doc: convert git-show to synopsis style
Documentation/asciidoc.conf.in | 6 +
Documentation/for-each-ref-options.adoc | 4 +-
Documentation/git-clone.adoc | 52 ++--
Documentation/git-show.adoc | 16 +-
Documentation/git-submodule.adoc | 369 ++++++++++++------------
Documentation/pretty-formats.adoc | 164 ++++++-----
6 files changed, 321 insertions(+), 290 deletions(-)
base-commit: d8af7cadaa79d5837d73ec949e10b57dedb43e9b
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2036%2Fjnavila%2Fgit_submodule-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2036/jnavila/git_submodule-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/2036
Range-diff vs v1:
1: 05e68e2825 = 1: 05e68e2825 convert git-submodule doc to synopsis style
2: 3a5b642d05 = 2: 3a5b642d05 doc: finalize git-clone documentation conversion to synopsis style
3: bcd6fcd119 = 3: bcd6fcd119 doc: fix some style issues in git-clone and for-each-ref-options
4: d078e1d94f ! 4: f6314e580d doc: convert git-show to synopsis style
@@ Documentation/pretty-formats.adoc: config option to either another format name,
++
+[synopsis]
+--
-+`<hash> <title-line>`
++<hash> <title-line>
+--
+
This is designed to be as compact as possible.
@@ Documentation/pretty-formats.adoc: colon and zero or more comma-separated option
++%(decorate:prefix=,suffix=,tag=,separator= )++
---
--++%(describe++`[:<option>,...]`++)++::
-+++%(`describe++``[:<option>,...]`++)++::
+ ++%(describe++`[:<option>,...]`++)++::
human-readable name, like linkgit:git-describe[1]; empty string for
- undescribable commits. The `describe` string may be followed by a colon and
+@@ Documentation/pretty-formats.adoc: undescribable commits. The `describe` string may be followed by a colon and
zero or more comma-separated options. Descriptions can be inconsistent when
tags are added or removed at the same time.
+
@@ Documentation/pretty-formats.adoc: multiple times, the last occurrence wins.
the literal formatting codes described above. To use comma as
separator one must use `%x2C` as it would otherwise be parsed as
next option. E.g., +%(trailers:key=Ticket,separator=%x2C )+
- shows all trailer lines whose key is "Ticket" separated by a comma
+- shows all trailer lines whose key is "Ticket" separated by a comma
++ shows all trailer lines whose key is `Ticket` separated by a comma
and a space.
-** `unfold[=<bool>]`: make it behave as if interpret-trailer's `--unfold`
+`unfold[=<bool>]`;; make it behave as if interpret-trailer's `--unfold`
--
gitgitgadget
next prev parent reply other threads:[~2026-01-26 21:25 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-23 21:14 [PATCH 0/4] doc: some more synopsis conversions and fixes Jean-Noël Avila via GitGitGadget
2026-01-23 21:15 ` [PATCH 1/4] convert git-submodule doc to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-01 12:04 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-01 12:04 ` Kristoffer Haugsbakk
2026-02-01 13:14 ` Jean-Noël AVILA
2026-02-02 8:36 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-01 12:11 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-01-25 19:27 ` Kristoffer Haugsbakk
2026-01-25 21:11 ` Jean-Noël AVILA
2026-01-26 5:58 ` Kristoffer Haugsbakk
2026-01-26 21:25 ` Jean-Noël Avila via GitGitGadget [this message]
2026-01-26 21:25 ` [PATCH v2 1/4] convert git-submodule doc " Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-01 12:12 ` Kristoffer Haugsbakk
2026-02-01 16:39 ` Jean-Noël AVILA
2026-02-03 17:03 ` [PATCH v3 0/4] doc: some more synopsis conversions and fixes Jean-Noël Avila via GitGitGadget
2026-02-03 17:03 ` [PATCH v3 1/4] doc: convert git-submodule to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-03 21:45 ` Kristoffer Haugsbakk
2026-02-06 3:55 ` Jean-Noël Avila
2026-02-03 17:03 ` [PATCH v3 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-03 21:45 ` Kristoffer Haugsbakk
2026-02-03 17:03 ` [PATCH v3 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-03 21:46 ` Kristoffer Haugsbakk
2026-02-03 17:03 ` [PATCH v3 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-03 21:44 ` Kristoffer Haugsbakk
2026-02-03 21:44 ` [PATCH v3 0/4] doc: some more synopsis conversions and fixes Kristoffer Haugsbakk
2026-02-04 16:24 ` Kristoffer Haugsbakk
2026-02-06 4:12 ` [PATCH v4 " Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 1/4] doc: convert git-submodule to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-07 14:24 ` [PATCH v4 0/4] doc: some more synopsis conversions and fixes Kristoffer Haugsbakk
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=pull.2036.v2.git.1769462744.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=jn.avila@free.fr \
--cc=kristofferhaugsbakk@fastmail.com \
/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