[PATCH v2 0/4] doc: some more synopsis conversions and fixes
- From
Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Jan 26, 2026, 21:25 UTC
- Message-ID
- <pull.2036.v2.git.1769462744.gitgitgadget@gmail.com>
- 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