git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Evan Gates <evan.gates@gmail.com>
To: git@vger.kernel.org
Subject: [PATCH] git-config: fix misworded --type=path explanation
Date: Fri, 15 Sep 2023 14:24:59 -0600	[thread overview]
Message-ID: <20230915202610.21206-1-evan.gates@gmail.com> (raw)

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


             reply	other threads:[~2023-09-15 20:26 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-15 20:24 Evan Gates [this message]
2023-09-16  6:16 ` [PATCH] git-config: fix misworded --type=path explanation Jeff King
2023-09-16 17:45 ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230915202610.21206-1-evan.gates@gmail.com \
    --to=evan.gates@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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 NNTP newsgroup(s).