]> git.ipfire.org Git - thirdparty/git.git/commitdiff
config: document --[no-]show-names
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Tue, 1 Jul 2025 15:14:28 +0000 (17:14 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 1 Jul 2025 17:28:38 +0000 (10:28 -0700)
These options were introduced in 4e513890008 (builtin/config:
introduce "get" subcommand, 2024-05-06) but not documented here.
Use the description from the source code.

Document this option and the negated form according to the current
convention.[1]

`--show-names` is also the default when `--get-regexp` is given.  But
don’t mention it here since all the deprecated modes are quarantined in
the “Deprecated Modes” section.

[1]: https://lore.kernel.org/git/xmqqcyct1mtq.fsf@gitster.g/

Acked-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-config.adoc

index 936e0c5130fe7d67f645501fbb9e70b94b437f54..e05bf813d46420da0e18e356fa6a7628365bae13 100644 (file)
@@ -259,6 +259,12 @@ Valid `<type>`'s include:
        Output only the names of config variables for `list` or
        `get`.
 
+`--show-names`::
+`--no-show-names`::
+       With `get`, show config keys in addition to their values. The
+       default is `--no-show-names` unless `--url` is given and there
+       are no subsections in _<name>_.
+
 --show-origin::
        Augment the output of all queried config options with the
        origin type (file, standard input, blob, command line) and