doc: remote.*.skip{DefaultUpdate,FetchAll} stops prefetch

Back when 7cc91a2f (Add the configuration option skipFetchAll,
2009-11-09) added for the sole purpose of adding skipFetchAll as a
synonym to skipDefaultUpdate, there was no explanation about the
reason why it was needed., but these two configuration variables
mean exactly the same thing.

Also, when we taught the "prefetch" task to "git maintenance" later,
we did make it pay attention to the setting, but we forgot to
document it.

Document these variables as synonyms that collectively implements
the last-one-wins semantics, and also clarify that the prefetch task
is also controlled by this variable.

Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config/remote.txt b/Documentation/config/remote.txt
index 8efc53e836d20bc1719e74fe6b3970f043584968..36e771556c67aaa59fb97da133d1622bb72484a9 100644 (file)
--- a/Documentation/config/remote.txt
+++ b/Documentation/config/remote.txt
@@ -42,14 +42,15 @@ remote.<name>.mirror::
        as if the `--mirror` option was given on the command line.
 
 remote.<name>.skipDefaultUpdate::
-       If true, this remote will be skipped by default when updating
-       using linkgit:git-fetch[1] or the `update` subcommand of
-       linkgit:git-remote[1].
+       A deprecated synonym to `remote.<name>.skipFetchAll` (if
+       both are set in the configuration files with different
+       values, the value of the last occurrence will be used).
 
 remote.<name>.skipFetchAll::
-       If true, this remote will be skipped by default when updating
-       using linkgit:git-fetch[1] or the `update` subcommand of
-       linkgit:git-remote[1].
+       If true, this remote will be skipped when updating
+       using linkgit:git-fetch[1], the `update` subcommand of
+       linkgit:git-remote[1], and ignored by the prefetch task
+       of `git maitenance`.
 
 remote.<name>.receivepack::
        The default program to execute on the remote side when pushing.  See

diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index e22b217fba9e2c6c30ad1f7becea238d0f2a9916..80838fe37ef30e857c4f4cdeba724a528c0bb622 100644 (file)
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -1,6 +1,7 @@
 --[no-]all::
-       Fetch all remotes. This overrides the configuration variable
-       `fetch.all`.
+       Fetch all remotes, except for the ones that has the
+       `remote.<name>.skipFetchAll` configuration variable set.
+       This overrides the configuration variable fetch.all`.
 
 -a::
 --append::

diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt
index 51d0f7e94b6a0182089d5d7f48ab9f9d1cb9f572..9d968191331080c8e14557e08a500297672660ce 100644 (file)
--- a/Documentation/git-maintenance.txt
+++ b/Documentation/git-maintenance.txt
@@ -107,6 +107,9 @@ with the prefetch task, the objects necessary to complete a later real fetch
 would already be obtained, making the real fetch faster.  In the ideal case,
 it will just become an update to a bunch of remote-tracking branches without
 any object transfer.
++
+The `remote.<name>.skipFetchAll` configuration can be used to
+exclude a particular remote from getting prefetched.
 
 gc::
        Clean up unnecessary files and optimize the local repository. "GC"