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>
Jean-Noël Avila committed
Sep 27, 2025 at 21:39 UTC
5a12fd2a8c850df311aa149c9bad87b7cb002abb
2 files changed
+15
-14
Documentation/config/extensions.adoc
+11
-12
@@ -3,8 +3,7 @@ extensions.*::
3
`core.repositoryFormatVersion` is not `1`. See
4
linkgit:gitrepository-layout[5].
5
+
6
---
7
-compatObjectFormat::
6
+compatObjectFormat:::
7
Specify a compatibility hash algorithm to use. The acceptable values
8
are `sha1` and `sha256`. The value specified must be different from the
9
value of `extensions.objectFormat`. This allows client level
@@ -15,18 +14,18 @@ compatObjectFormat::
14
compatObjectFormat in addition to oids encoded with objectFormat to
15
locally specify objects.
16
18
-noop::
17
+noop:::
18
This extension does not change git's behavior at all. It is useful only
19
for testing format-1 compatibility.
20
+
21
For historical reasons, this extension is respected regardless of the
22
`core.repositoryFormatVersion` setting.
23
25
-noop-v1::
24
+noop-v1:::
25
This extension does not change git's behavior at all. It is useful only
26
for testing format-1 compatibility.
27
29
-objectFormat::
28
+objectFormat:::
29
Specify the hash algorithm to use. The acceptable values are `sha1` and
30
`sha256`. If not specified, `sha1` is assumed.
31
+
@@ -34,7 +33,7 @@ Note that this setting should only be set by linkgit:git-init[1] or
33
linkgit:git-clone[1]. Trying to change it after initialization will not
34
work and will produce hard-to-diagnose issues.
35
37
-partialClone::
36
+partialClone:::
37
When enabled, indicates that the repo was created with a partial clone
38
(or later performed a partial fetch) and that the remote may have
39
omitted sending certain unwanted objects. Such a remote is called a
@@ -46,14 +45,14 @@ The value of this key is the name of the promisor remote.
45
For historical reasons, this extension is respected regardless of the
46
`core.repositoryFormatVersion` setting.
47
49
-preciousObjects::
48
+preciousObjects:::
49
If enabled, indicates that objects in the repository MUST NOT be deleted
50
(e.g., by `git-prune` or `git repack -d`).
51
+
52
For historical reasons, this extension is respected regardless of the
53
`core.repositoryFormatVersion` setting.
54
56
-refStorage::
55
+refStorage:::
56
Specify the ref storage format to use. The acceptable values are:
57
+
58
include::../ref-storage-format.adoc[]
@@ -63,13 +62,13 @@ Note that this setting should only be set by linkgit:git-init[1] or
62
linkgit:git-clone[1]. Trying to change it after initialization will not
63
work and will produce hard-to-diagnose issues.
64
66
-relativeWorktrees::
65
+relativeWorktrees:::
66
If enabled, indicates at least one worktree has been linked with
67
relative paths. Automatically set if a worktree has been created or
68
repaired with either the `--relative-paths` option or with the
69
`worktree.useRelativePaths` config set to `true`.
70
72
-worktreeConfig::
71
+worktreeConfig:::
72
If enabled, then worktrees will load config settings from the
73
`$GIT_DIR/config.worktree` file in addition to the
74
`$GIT_COMMON_DIR/config` file. Note that `$GIT_COMMON_DIR` and
@@ -83,11 +82,12 @@ When enabling this extension, you must be careful to move
82
certain values from the common config file to the main working tree's
83
`config.worktree` file, if present:
84
+
85
+--
86
* `core.worktree` must be moved from `$GIT_COMMON_DIR/config` to
87
`$GIT_COMMON_DIR/config.worktree`.
88
* If `core.bare` is true, then it must be moved from `$GIT_COMMON_DIR/config`
89
to `$GIT_COMMON_DIR/config.worktree`.
90
-
90
+--
91
+
92
It may also be beneficial to adjust the locations of `core.sparseCheckout`
93
and `core.sparseCheckoutCone` depending on your desire for customizable
@@ -100,4 +100,3 @@ details.
100
+
101
For historical reasons, this extension is respected regardless of the
102
`core.repositoryFormatVersion` setting.
103
---
Documentation/pretty-formats.adoc
+4
-2
@@ -232,7 +232,7 @@ ref names with custom decorations. The `decorate` string may be followed by a
232
colon and zero or more comma-separated options. Option values may contain
233
literal formatting codes. These must be used for commas (`%x2C`) and closing
234
parentheses (`%x29`), due to their role in the option syntax.
235
-+
235
+
236
** `prefix=<value>`: Shown before the list of ref names. Defaults to "{nbsp}+(+".
237
** `suffix=<value>`: Shown after the list of ref names. Defaults to "+)+".
238
** `separator=<value>`: Shown between ref names. Defaults to "+,+{nbsp}".
@@ -241,10 +241,12 @@ parentheses (`%x29`), due to their role in the option syntax.
241
** `tag=<value>`: Shown before tag names. Defaults to "`tag:`{nbsp}".
242
243
+
244
+--
245
For example, to produce decorations with no wrapping
246
or tag annotations, and spaces as separators:
246
-+
247
+
248
++%(decorate:prefix=,suffix=,tag=,separator= )++
249
+--
250
251
++%(describe++`[:<option>,...]`++)++::
252
human-readable name, like linkgit:git-describe[1]; empty string for