]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: change the markup of paragraphs following a nested list item
authorJean-Noël Avila <jn.avila@free.fr>
Sat, 27 Sep 2025 19:39:45 +0000 (21:39 +0200)
committerJunio C Hamano <gitster@pobox.com>
Sun, 28 Sep 2025 00:35:29 +0000 (17:35 -0700)
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>
Documentation/config/extensions.adoc
Documentation/pretty-formats.adoc

index 9e2f321a6d776fc810545dc324d8410d4d2fc191..49a7598ca5cd133127e6565b7c400fe21930943a 100644 (file)
@@ -3,8 +3,7 @@ extensions.*::
        `core.repositoryFormatVersion` is not `1`. See
        linkgit:gitrepository-layout[5].
 +
---
-compatObjectFormat::
+compatObjectFormat:::
        Specify a compatibility hash algorithm to use.  The acceptable values
        are `sha1` and `sha256`.  The value specified must be different from the
        value of `extensions.objectFormat`.  This allows client level
@@ -15,18 +14,18 @@ compatObjectFormat::
        compatObjectFormat in addition to oids encoded with objectFormat to
        locally specify objects.
 
-noop::
+noop:::
        This extension does not change git's behavior at all. It is useful only
        for testing format-1 compatibility.
 +
 For historical reasons, this extension is respected regardless of the
 `core.repositoryFormatVersion` setting.
 
-noop-v1::
+noop-v1:::
        This extension does not change git's behavior at all. It is useful only
        for testing format-1 compatibility.
 
-objectFormat::
+objectFormat:::
        Specify the hash algorithm to use.  The acceptable values are `sha1` and
        `sha256`.  If not specified, `sha1` is assumed.
 +
@@ -34,7 +33,7 @@ Note that this setting should only be set by linkgit:git-init[1] or
 linkgit:git-clone[1].  Trying to change it after initialization will not
 work and will produce hard-to-diagnose issues.
 
-partialClone::
+partialClone:::
        When enabled, indicates that the repo was created with a partial clone
        (or later performed a partial fetch) and that the remote may have
        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.
 For historical reasons, this extension is respected regardless of the
 `core.repositoryFormatVersion` setting.
 
-preciousObjects::
+preciousObjects:::
        If enabled, indicates that objects in the repository MUST NOT be deleted
        (e.g., by `git-prune` or `git repack -d`).
 +
 For historical reasons, this extension is respected regardless of the
 `core.repositoryFormatVersion` setting.
 
-refStorage::
+refStorage:::
        Specify the ref storage format to use. The acceptable values are:
 +
 include::../ref-storage-format.adoc[]
@@ -63,13 +62,13 @@ Note that this setting should only be set by linkgit:git-init[1] or
 linkgit:git-clone[1]. Trying to change it after initialization will not
 work and will produce hard-to-diagnose issues.
 
-relativeWorktrees::
+relativeWorktrees:::
        If enabled, indicates at least one worktree has been linked with
        relative paths. Automatically set if a worktree has been created or
        repaired with either the `--relative-paths` option or with the
        `worktree.useRelativePaths` config set to `true`.
 
-worktreeConfig::
+worktreeConfig:::
        If enabled, then worktrees will load config settings from the
        `$GIT_DIR/config.worktree` file in addition to the
        `$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
 certain values from the common config file to the main working tree's
 `config.worktree` file, if present:
 +
+--
 * `core.worktree` must be moved from `$GIT_COMMON_DIR/config` to
   `$GIT_COMMON_DIR/config.worktree`.
 * If `core.bare` is true, then it must be moved from `$GIT_COMMON_DIR/config`
   to `$GIT_COMMON_DIR/config.worktree`.
-
+--
 +
 It may also be beneficial to adjust the locations of `core.sparseCheckout`
 and `core.sparseCheckoutCone` depending on your desire for customizable
@@ -100,4 +100,3 @@ details.
 +
 For historical reasons, this extension is respected regardless of the
 `core.repositoryFormatVersion` setting.
---
index 9ed0417fc811e5b3f9c4fba9853bb95ccf4b67c9..3d7a8885b696f62deb64eb1bc619e0c57d1eec27 100644 (file)
@@ -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