]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: config: terminate runaway lists
authorTuomas Ahola <taahol@utu.fi>
Thu, 11 Jun 2026 16:19:44 +0000 (19:19 +0300)
committerJunio C Hamano <gitster@pobox.com>
Thu, 11 Jun 2026 19:08:17 +0000 (12:08 -0700)
There are many places in git-config(1) where paragraphs that should
logically come after a list are instead appended to the last item of
the list.  This is a well-documented quirk of AsciiDoc, and can be
mitigated by enclosing the list in an open block:

--
* first item
* last item
--
+
New paragraph after the list.

Fix the issue accordingly.

Signed-off-by: Tuomas Ahola <taahol@utu.fi>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config.adoc
Documentation/config/promisor.adoc
Documentation/config/safe.adoc
Documentation/git-config.adoc

index dcea3c0c15e2a93d271adf4d1322763257bcc4f9..fc48c1c4618778e52ab491e2cf593a71b902b643 100644 (file)
@@ -276,13 +276,15 @@ boolean::
        When a variable is said to take a boolean value, many
        synonyms are accepted for 'true' and 'false'; these are all
        case-insensitive.
-
++
+--
        true;; Boolean true literals are `yes`, `on`, `true`,
                and `1`.  Also, a variable defined without `= <value>`
                is taken as true.
 
        false;; Boolean false literals are `no`, `off`, `false`,
                `0` and the empty string.
+--
 +
 When converting a value to its canonical form using the `--type=bool` type
 specifier, 'git config' will ensure that the output is "true" or
index b0fa43b8393a53b8db976c5cda3d9b046324780a..39af63dcb87a32c9531e939ee6834a074a0bd3b2 100644 (file)
@@ -63,11 +63,13 @@ If one of these field names (e.g., "token") is being checked for an
 advertised promisor remote (e.g., "foo"), three conditions must be met
 for the check of this specific field to pass:
 +
+--
 1. The corresponding local configuration (e.g., `remote.foo.token`)
    must be set.
 2. The server must advertise the "token" field for remote "foo".
 3. The value of the locally configured `remote.foo.token` must exactly
    match the value advertised by the server for the "token" field.
+--
 +
 If any of these conditions is not met for any field name listed in
 `promisor.checkFields`, the advertised remote "foo" is rejected.
index 2d45c98b12d9519ac92e82fa0545045f372c8d19..5ae4476b24cbd7ffbcac8941eb7cce62ed5c7a44 100644 (file)
@@ -2,10 +2,12 @@ safe.bareRepository::
        Specifies which bare repositories Git will work with. The currently
        supported values are:
 +
+--
 * `all`: Git works with all bare repositories. This is the default.
 * `explicit`: Git only works with bare repositories specified via
   the top-level `--git-dir` command-line option, or the `GIT_DIR`
   environment variable (see linkgit:git[1]).
+--
 +
 If you do not use bare repositories in your workflow, then it may be
 beneficial to set `safe.bareRepository` to `explicit` in your global
index 00545b20542c60c7d0697ffd38b9d5b0b95016b1..8439ce97df95f26fcde9f61a332807ca9022adf4 100644 (file)
@@ -221,6 +221,7 @@ Use `--no-value` to unset _<pattern>_.
 +
 Valid `<type>`'s include:
 +
+--
 - 'bool': canonicalize values `true`, `yes`, `on`, and positive
   numbers as "true", and values `false`, `no`, `off` and `0` as
   "false".
@@ -239,6 +240,7 @@ Valid `<type>`'s include:
   escape sequence. When setting a value, a sanity-check is performed to ensure
   that the given value is canonicalize-able as an ANSI color, but it is written
   as-is.
+--
 +
 If the command is in `list` mode, then the `--type <type>` argument will apply
 to each listed config value. If the value does not successfully parse in that