summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Lyles <brianmlyles@gmail.com>2024-03-16 00:01:24 -0500
committerJunio C Hamano <gitster@pobox.com>2024-03-16 09:52:10 -0700
commit7823a5120356ed655febe7c0378669baa0da1d4e (patch)
tree7e567bf6450aed92cd9b1eac9c37f3d9a8c84b4f
parent3c2a3fdc388747b9eaf4a4a4f2035c1c9ddb26d0 (diff)
docs: clarify file options in git-config `--edit`
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>
-rw-r--r--Documentation/git-config.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index dff39093b5..6876803253 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -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