aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/pretty-formats.adoc
diff options
context:
space:
mode:
authorJean-Noël Avila <jn.avila@free.fr>2025-09-27 21:39:45 +0200
committerJunio C Hamano <gitster@pobox.com>2025-09-27 17:35:29 -0700
commit5a12fd2a8c850df311aa149c9bad87b7cb002abb (patch)
treeff3ba6ec585d83eaa3df0a813524de112a4931dc /Documentation/pretty-formats.adoc
parentGit 2.51 (diff)
downloadgit-5a12fd2a8c850df311aa149c9bad87b7cb002abb.tar.gz
git-5a12fd2a8c850df311aa149c9bad87b7cb002abb.zip
doc: change the markup of paragraphs following a nested list item
Asciidoctor and asciidoc.py have different behaviors when a paragraph follows a nested list item. Asciidoctor has a bug[1] that makes it keep a plus sign (+) used to attached paragraphs at the beginning of the paragraph. This commit uses workarounds to avoid this problem by using second level definition lists and open blocks. [1]:https://github.com/asciidoctor/asciidoctor/issues/4704 Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to '')
-rw-r--r--Documentation/pretty-formats.adoc6
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/pretty-formats.adoc b/Documentation/pretty-formats.adoc
index 9ed0417fc8..3d7a8885b6 100644
--- a/Documentation/pretty-formats.adoc
+++ b/Documentation/pretty-formats.adoc
@@ -232,7 +232,7 @@ ref names with custom decorations. The `decorate` string may be followed by a
colon and zero or more comma-separated options. Option values may contain
literal formatting codes. These must be used for commas (`%x2C`) and closing
parentheses (`%x29`), due to their role in the option syntax.
-+
+
** `prefix=<value>`: Shown before the list of ref names. Defaults to "{nbsp}+(+".
** `suffix=<value>`: Shown after the list of ref names. Defaults to "+)+".
** `separator=<value>`: Shown between ref names. Defaults to "+,+{nbsp}".
@@ -241,10 +241,12 @@ parentheses (`%x29`), due to their role in the option syntax.
** `tag=<value>`: Shown before tag names. Defaults to "`tag:`{nbsp}".
+
+--
For example, to produce decorations with no wrapping
or tag annotations, and spaces as separators:
-+
+
++%(decorate:prefix=,suffix=,tag=,separator= )++
+--
++%(describe++`[:<option>,...]`++)++::
human-readable name, like linkgit:git-describe[1]; empty string for