diff --git a/Documentation/config.adoc b/Documentation/config.adoc index bc3798eaec..2c566e7c4a 100644 --- a/Documentation/config.adoc +++ b/Documentation/config.adoc @@ -324,13 +324,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 `= ` 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 diff --git a/Documentation/config/promisor.adoc b/Documentation/config/promisor.adoc index f07a2e883b..c1f3d766a6 100644 --- a/Documentation/config/promisor.adoc +++ b/Documentation/config/promisor.adoc @@ -175,11 +175,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. diff --git a/Documentation/config/safe.adoc b/Documentation/config/safe.adoc index 5b1690aebe..99fbfc0618 100644 --- a/Documentation/config/safe.adoc +++ b/Documentation/config/safe.adoc @@ -2,12 +2,14 @@ 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 in Git 2.x. * `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]). This will be the default in Git 3.0. +-- + If you do not use bare repositories in your workflow, then it may be beneficial to set `safe.bareRepository` to `explicit` in your global diff --git a/Documentation/config/sideband.adoc b/Documentation/config/sideband.adoc index ff007aeb73..f5b159e15f 100644 --- a/Documentation/config/sideband.adoc +++ b/Documentation/config/sideband.adoc @@ -9,7 +9,7 @@ sideband.allowControlCharacters:: `color`:: Allow ANSI color sequences, line feeds and horizontal tabs, but mask all other control characters. This is the default. - `cursor:`: + `cursor`:: Allow control sequences that move the cursor. This is disabled by default. `erase`:: diff --git a/Documentation/git-config.adoc b/Documentation/git-config.adoc index c9b5159501..b918ec77db 100644 --- a/Documentation/git-config.adoc +++ b/Documentation/git-config.adoc @@ -119,10 +119,10 @@ OPTIONS Append a comment at the end of new or modified lines. + If __ begins with one or more whitespaces followed -by "#", it is used as-is. If it begins with "#", a space is -prepended before it is used. Otherwise, a string " # " (a +by `#`, it is used as-is. If it begins with `#`, a space is +prepended before it is used. Otherwise, a string `" # "` (a space followed by a hash followed by a space) is prepended -to it. And the resulting string is placed immediately after +to it. The resulting string is placed immediately after the value defined for the variable. The __ must not contain linefeed characters (no multi-line comments are permitted). @@ -221,6 +221,7 @@ Use `--no-value` to unset __. + Valid ``'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 ``'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 ` argument will apply to each listed config value. If the value does not successfully parse in that