| Message ID | 20230915202610.21206-1-evan.gates@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 58be11432edfe2fc9887266fe9dbc450b5547e78 |
| Headers | show |
| Series | git-config: fix misworded --type=path explanation | expand |
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
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.
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.)
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(-)