[PATCH] doc: clarify gitcredentials path component matching

[PATCH] doc: clarify gitcredentials path component matching

[Zych, David M]

The gitcredentials documentation implied that the config file's
"pattern" URL might include a path component, but did not explain that
it must match exactly (potentially leaving readers with the false hope
that it would support a more flexible prefix match).

Signed-off-by: David Zych <dmrz@illinois.edu>
---
 Documentation/gitcredentials.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
index f970196..adc7596 100644
--- a/Documentation/gitcredentials.txt
+++ b/Documentation/gitcredentials.txt
@@ -133,6 +133,12 @@ compares hostnames exactly, without considering whether two hosts are part of
 the same domain. Likewise, a config entry for `http://example.com` would not
 match: Git compares the protocols exactly.
 
+If the "pattern" URL does include a path component, then this too must match
+exactly: the context `https://example.com/bar/baz.git` will match a config
+entry for `https://example.com/bar/baz.git` (in addition to matching the config
+entry for `https://example.com`) but will not match a config entry for
+`https://example.com/bar`.
+
 
 CONFIGURATION OPTIONS
 ---------------------
-- 
2.7.4

Re: [PATCH] doc: clarify gitcredentials path component matching

[Jeff King]

On Wed, Sep 26, 2018 at 10:23:11PM +0000, Zych, David M wrote:

> The gitcredentials documentation implied that the config file's
> "pattern" URL might include a path component, but did not explain that
> it must match exactly (potentially leaving readers with the false hope
> that it would support a more flexible prefix match).
> [...]

Thanks, the proposed text looks perfect to me.

-Peff