* [PATCH] git-config: fix misworded --type=path explanation
@ 2023-09-15 20:24 Evan Gates
2023-09-16 6:16 ` Jeff King
2023-09-16 17:45 ` Junio C Hamano
0 siblings, 2 replies; 3+ messages in thread
From: Evan Gates @ 2023-09-15 20:24 UTC (permalink / raw)
To: git
When `--type=<type>` was added as a prefered alias for `--<type>`
the explanation for the path type was reworded. Whereas the previous
explanation said "expand a leading `~`" this was changed to "adding a
leading `~`". Change "adding" to "expanding" to correctly explain the
canonicalization.
Fixes: fb0dc3bac1 (builtin/config.c: support `--type=<type>` as preferred alias for `--<type>`)
Signed-off-by: Evan Gates <evan.gates@gmail.com>
---
Turns out --type=path is exactly what I had been looking for, but
it took some experimentation as I found the documentation confusing.
In hindsight it's obvious, but I hope this simple fix helps someone else
figure it out faster in the future.
Documentation/git-config.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 7a2bcb2f6c..b1caac887a 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -201,7 +201,7 @@ Valid `<type>`'s include:
1073741824 upon input.
- 'bool-or-int': canonicalize according to either 'bool' or 'int', as described
above.
-- 'path': canonicalize by adding a leading `~` to the value of `$HOME` and
+- 'path': canonicalize by expanding a leading `~` to the value of `$HOME` and
`~user` to the home directory for the specified user. This specifier has no
effect when setting the value (but you can use `git config section.variable
~/` from the command line to let your shell do the expansion.)
--
2.42.0
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] git-config: fix misworded --type=path explanation
2023-09-15 20:24 [PATCH] git-config: fix misworded --type=path explanation Evan Gates
@ 2023-09-16 6:16 ` Jeff King
2023-09-16 17:45 ` Junio C Hamano
1 sibling, 0 replies; 3+ messages in thread
From: Jeff King @ 2023-09-16 6:16 UTC (permalink / raw)
To: Evan Gates; +Cc: git
On Fri, Sep 15, 2023 at 02:24:59PM -0600, Evan Gates wrote:
> When `--type=<type>` was added as a prefered alias for `--<type>`
> the explanation for the path type was reworded. Whereas the previous
> explanation said "expand a leading `~`" this was changed to "adding a
> leading `~`". Change "adding" to "expanding" to correctly explain the
> canonicalization.
Yeah, the sentence as-is does not make any sense. Your suggested wording
looks good to me. Thanks.
-Peff
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] git-config: fix misworded --type=path explanation
2023-09-15 20:24 [PATCH] git-config: fix misworded --type=path explanation Evan Gates
2023-09-16 6:16 ` Jeff King
@ 2023-09-16 17:45 ` Junio C Hamano
1 sibling, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2023-09-16 17:45 UTC (permalink / raw)
To: Evan Gates; +Cc: git
Evan Gates <evan.gates@gmail.com> writes:
> When `--type=<type>` was added as a prefered alias for `--<type>`
> the explanation for the path type was reworded. Whereas the previous
> explanation said "expand a leading `~`" this was changed to "adding a
> leading `~`". Change "adding" to "expanding" to correctly explain the
> canonicalization.
Nice spotting (and good archaeology, too).
Thanks.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-09-16 17:46 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-09-15 20:24 [PATCH] git-config: fix misworded --type=path explanation Evan Gates
2023-09-16 6:16 ` Jeff King
2023-09-16 17:45 ` Junio C Hamano
Code repositories for project(s) associated with this public inbox
https://80x24.org/pub/scm/git/git.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).