Add support for url aliases in config files

[thirdparty/git.git] / Documentation / config.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index f2f6a774e044e03e78d83e4e77aedcff122f5688..298138917a3eb5a0f75ff11a09d286efef3d45b5 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -886,6 +886,18 @@ tar.umask::
        archiving user's umask will be used instead.  See umask(2) and
        linkgit:git-archive[1].
 
+url.<base>.insteadOf::
+       Any URL that starts with this value will be rewritten to
+       start, instead, with <base>. In cases where some site serves a
+       large number of repositories, and serves them with multiple
+       access methods, and some users need to use different access
+       methods, this feature allows people to specify any of the
+       equivalent URLs and have git automatically rewrite the URL to
+       the best alternative for the particular user, even for a
+       never-before-seen repository on the site. The effect of
+       having multiple `insteadOf` values from different
+       `<base>` match to an URL is undefined.
+
 user.email::
        Your email address to be recorded in any newly created commits.
        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and