git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 1/2] docs: clarify file options in git-config `--edit`

From
Brian Lyles <brianmlyles@gmail.com>
Date
Mar 16, 2024, 05:01 UTC
Message-ID
<20240316050149.1182867-1-brianmlyles@gmail.com>

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>
---
 Documentation/git-config.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
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
-- 
2.43.0
Next: Brian Lyles
Message 1 of 4 in “docs: clarify file options in git-config `--edit`”
  1. 1/2 docs: clarify file options in git-config `--edit`Brian Lyles, Mar 16, 2024
  2. 2/2 docs: fix typo in git-config `--default`Brian Lyles, Mar 16, 2024
  3. Patrick SteinhardtMar 21, 2024
  4. Junio C HamanoMar 21, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.