Re: [REQUEST 1/1] docs: update http.<url>.* options documentation

From: Jeff King <peff@peff.net>
Date: Jul 27, 2013, 02:43 UTC
Message-ID: <20130727024353.GA19853@sigill.intra.peff.net>
In-Reply-To: <251106F7-56FA-4503-A4C9-267A5EF04A2C@gmail.com>

On Fri, Jul 26, 2013 at 07:15:07PM -0700, Kyle J. McKay wrote:

Show 6 quoted lines

> So there's a version of this in next as cea9928 and I think that
> version is fine.  If the documentation gets updated in the future, or
> perhaps moved to a separate urls-matching.txt for some reason at some
> point (git config --url, git config --url-parse), I'll make a point
> of inserting the ", but at lower precedence than a config key with a
> user name" text.

Unless you are planning to do that immediately, we are very likely to forget. Either it is worth adding or not, and if it is, we should not let having to add one more commit stop us.

Here it is in patch form, so the amount of effort does not influence our decision. :)

I'd lean towards including it, but don't feel strongly.

-- >8 --
Subject: [PATCH] docs: mention precedence of empty username matching in URLs

The documentation makes it clear that a URL with a username will match a config entry with or without a username, but is not clear that in the presence of both, the one with username would be preferred.

Signed-off-by: Jeff King <peff@peff.net>
---
 Documentation/config.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 0dd5566..f2ed9ef 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1568,7 +1568,8 @@ http.<url>.*::
 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
   the config key has a user name it must match the user name in the
   URL exactly. If the config key does not have a user name, that
-  config key will match a URL with any user name (including none).
+  config key will match a URL with any user name (including none),
+  but at a lower precedence than a config key with a user name.
 --
 +
 The list above is ordered by decreasing precedence; a URL that matches

-- 
1.8.3.rc1.30.gff0fb75