Skip to content

doc: config: fix AsciiDoc glitches

Tuomas Ahola git 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest3 patches 4 repliesIn review
  2. v23 patches 11 repliesSuperseded
  3. v13 patches 3 repliesSuperseded

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3doc: config: terminate runaway listsDocumentation/config.adoc Documentation/config/promisor.adoc Documentation/config/safe.adoc +1 more+9 -10 replies
2/3doc: config/sideband: fix description list delimiterDocumentation/config/sideband.adoc+1 -10 replies
3/3doc: git-config: escape erroneous highlight markupDocumentation/git-config.adoc+3 -30 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.

Read the v3 thread

Cover letter [PATCH v3 0/3] doc: config: fix AsciiDoc glitches

Fix various markup shortcomings in git-config(1).

Based on 29bd7ed512 (The second batch, 2026-05-12).

Tuomas Ahola (3):
doc: config: terminate runaway lists
doc: config/sideband: fix description list delimiter
doc: git-config: escape erroneous highlight markup

 Documentation/config.adoc          | 4 +++-
 Documentation/config/promisor.adoc | 2 ++
 Documentation/config/safe.adoc     | 2 ++
 Documentation/config/sideband.adoc | 2 +-
 Documentation/git-config.adoc      | 8 +++++---
 5 files changed, 13 insertions(+), 5 deletions(-)

Intervall-diff mot v2:

-:  ---------- > 1:  c9131b23fd doc: config: terminate runaway lists
-:  ---------- > 2:  ca65211ea4 doc: config/sideband: fix description list delimiter
1:  0341a4bde9 ! 3:  e2d0cc8218 doc: git-config: escape erroneous highlight markup

@@ Commit message

Paired octothorpes are used in AsciiDoc to mark highlighted text, <mark> being the equivalent HTML tag. To use the symbol as a literal
- character, it can be escaped with a backslash.
+ character, it can be escaped with backticks.

Do so in git-config.adoc.

@@ Documentation/git-config.adoc: OPTIONS
+
If _<message>_ begins with one or more whitespaces followed
-by "#", it is used as-is. If it begins with "#", a space is
-+by "\#", it is used as-is. If it begins with "\#", a space is
- prepended before it is used. Otherwise, a string " # " (a +-prepended before it is used. Otherwise, a string " # " (a ++by #, it is used as-is. If it begins with #, a space is ++prepended before it is used. Otherwise, a string " # " (a space followed by a hash followed by a space) is prepended -to it. And the resulting string is placed immediately after +to it. The resulting string is placed immediately after

base-commit: 29bd7ed5127255713c1ac2f43b7c6f257d7b4594

Signature · 1 line
2.30.2