Skip to content

Commit 5a12fd2

Browse files
jnavilagitster
authored andcommitted
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]:asciidoctor/asciidoctor#4704 Signed-off-by: Jean-Noël Avila <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c44beea commit 5a12fd2

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

Documentation/config/extensions.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ extensions.*::
33
`core.repositoryFormatVersion` is not `1`. See
44
linkgit:gitrepository-layout[5].
55
+
6-
--
7-
compatObjectFormat::
6+
compatObjectFormat:::
87
Specify a compatibility hash algorithm to use. The acceptable values
98
are `sha1` and `sha256`. The value specified must be different from the
109
value of `extensions.objectFormat`. This allows client level
@@ -15,26 +14,26 @@ compatObjectFormat::
1514
compatObjectFormat in addition to oids encoded with objectFormat to
1615
locally specify objects.
1716
18-
noop::
17+
noop:::
1918
This extension does not change git's behavior at all. It is useful only
2019
for testing format-1 compatibility.
2120
+
2221
For historical reasons, this extension is respected regardless of the
2322
`core.repositoryFormatVersion` setting.
2423
25-
noop-v1::
24+
noop-v1:::
2625
This extension does not change git's behavior at all. It is useful only
2726
for testing format-1 compatibility.
2827
29-
objectFormat::
28+
objectFormat:::
3029
Specify the hash algorithm to use. The acceptable values are `sha1` and
3130
`sha256`. If not specified, `sha1` is assumed.
3231
+
3332
Note that this setting should only be set by linkgit:git-init[1] or
3433
linkgit:git-clone[1]. Trying to change it after initialization will not
3534
work and will produce hard-to-diagnose issues.
3635
37-
partialClone::
36+
partialClone:::
3837
When enabled, indicates that the repo was created with a partial clone
3938
(or later performed a partial fetch) and that the remote may have
4039
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.
4645
For historical reasons, this extension is respected regardless of the
4746
`core.repositoryFormatVersion` setting.
4847
49-
preciousObjects::
48+
preciousObjects:::
5049
If enabled, indicates that objects in the repository MUST NOT be deleted
5150
(e.g., by `git-prune` or `git repack -d`).
5251
+
5352
For historical reasons, this extension is respected regardless of the
5453
`core.repositoryFormatVersion` setting.
5554
56-
refStorage::
55+
refStorage:::
5756
Specify the ref storage format to use. The acceptable values are:
5857
+
5958
include::../ref-storage-format.adoc[]
@@ -63,13 +62,13 @@ Note that this setting should only be set by linkgit:git-init[1] or
6362
linkgit:git-clone[1]. Trying to change it after initialization will not
6463
work and will produce hard-to-diagnose issues.
6564
66-
relativeWorktrees::
65+
relativeWorktrees:::
6766
If enabled, indicates at least one worktree has been linked with
6867
relative paths. Automatically set if a worktree has been created or
6968
repaired with either the `--relative-paths` option or with the
7069
`worktree.useRelativePaths` config set to `true`.
7170
72-
worktreeConfig::
71+
worktreeConfig:::
7372
If enabled, then worktrees will load config settings from the
7473
`$GIT_DIR/config.worktree` file in addition to the
7574
`$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
8382
certain values from the common config file to the main working tree's
8483
`config.worktree` file, if present:
8584
+
85+
--
8686
* `core.worktree` must be moved from `$GIT_COMMON_DIR/config` to
8787
`$GIT_COMMON_DIR/config.worktree`.
8888
* If `core.bare` is true, then it must be moved from `$GIT_COMMON_DIR/config`
8989
to `$GIT_COMMON_DIR/config.worktree`.
90-
90+
--
9191
+
9292
It may also be beneficial to adjust the locations of `core.sparseCheckout`
9393
and `core.sparseCheckoutCone` depending on your desire for customizable
@@ -100,4 +100,3 @@ details.
100100
+
101101
For historical reasons, this extension is respected regardless of the
102102
`core.repositoryFormatVersion` setting.
103-
--

Documentation/pretty-formats.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ ref names with custom decorations. The `decorate` string may be followed by a
232232
colon and zero or more comma-separated options. Option values may contain
233233
literal formatting codes. These must be used for commas (`%x2C`) and closing
234234
parentheses (`%x29`), due to their role in the option syntax.
235-
+
235+
236236
** `prefix=<value>`: Shown before the list of ref names. Defaults to "{nbsp}+(+".
237237
** `suffix=<value>`: Shown after the list of ref names. Defaults to "+)+".
238238
** `separator=<value>`: Shown between ref names. Defaults to "+,+{nbsp}".
@@ -241,10 +241,12 @@ parentheses (`%x29`), due to their role in the option syntax.
241241
** `tag=<value>`: Shown before tag names. Defaults to "`tag:`{nbsp}".
242242
243243
+
244+
--
244245
For example, to produce decorations with no wrapping
245246
or tag annotations, and spaces as separators:
246-
+
247+
247248
++%(decorate:prefix=,suffix=,tag=,separator= )++
249+
--
248250
249251
++%(describe++`[:<option>,...]`++)++::
250252
human-readable name, like linkgit:git-describe[1]; empty string for

0 commit comments

Comments
 (0)