]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs: clarify file options in git-config `--edit`
authorBrian Lyles <brianmlyles@gmail.com>
Sat, 16 Mar 2024 05:01:24 +0000 (00:01 -0500)
committerJunio C Hamano <gitster@pobox.com>
Sat, 16 Mar 2024 16:52:10 +0000 (09:52 -0700)
The description for the `-e`/`--edit` option references scopes
inconsistently: system and global are referenced by their option name
(`--system`/`--global`), but repository (`--local` is not. Additionally,
neither `--worktree` nor `--file` are referenced at all, despite also
being a valid options.

Update the description to mention all four available scopes as well as
`--file`, referencing each consistently by their option name.

Signed-off-by: Brian Lyles <brianmlyles@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-config.txt

index dff39093b5ef322ce115afc8f4bee0c728b6173a..6876803253c375eab48b9bfe2087f8a94a751ad8 100644 (file)
@@ -275,7 +275,8 @@ Valid `<type>`'s include:
 -e::
 --edit::
        Opens an editor to modify the specified config file; either
-       `--system`, `--global`, or repository (default).
+       `--system`, `--global`, `--local` (default), `--worktree`, or
+       `--file <config-file>`.
 
 --[no-]includes::
        Respect `include.*` directives in config files when looking up