Skip to content

Commit 9a36ea3

Browse files
committed
doc: remote.*.skip{DefaultUpdate,FetchAll} stops prefetch
Back when 7cc91a2 (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 <[email protected]>
1 parent 39bf06a commit 9a36ea3

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

Documentation/config/remote.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,15 @@ remote.<name>.mirror::
4242
as if the `--mirror` option was given on the command line.
4343

4444
remote.<name>.skipDefaultUpdate::
45-
If true, this remote will be skipped by default when updating
46-
using linkgit:git-fetch[1] or the `update` subcommand of
47-
linkgit:git-remote[1].
45+
A deprecated synonym to `remote.<name>.skipFetchAll` (if
46+
both are set in the configuration files with different
47+
values, the value of the last occurrence will be used).
4848

4949
remote.<name>.skipFetchAll::
50-
If true, this remote will be skipped by default when updating
51-
using linkgit:git-fetch[1] or the `update` subcommand of
52-
linkgit:git-remote[1].
50+
If true, this remote will be skipped when updating
51+
using linkgit:git-fetch[1], the `update` subcommand of
52+
linkgit:git-remote[1], and ignored by the prefetch task
53+
of `git maitenance`.
5354

5455
remote.<name>.receivepack::
5556
The default program to execute on the remote side when pushing. See

Documentation/fetch-options.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
--[no-]all::
2-
Fetch all remotes. This overrides the configuration variable
3-
`fetch.all`.
2+
Fetch all remotes, except for the ones that has the
3+
`remote.<name>.skipFetchAll` configuration variable set.
4+
This overrides the configuration variable fetch.all`.
45

56
-a::
67
--append::

Documentation/git-maintenance.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,9 @@ with the prefetch task, the objects necessary to complete a later real fetch
107107
would already be obtained, making the real fetch faster. In the ideal case,
108108
it will just become an update to a bunch of remote-tracking branches without
109109
any object transfer.
110+
+
111+
The `remote.<name>.skipFetchAll` configuration can be used to
112+
exclude a particular remote from getting prefetched.
110113

111114
gc::
112115
Clean up unnecessary files and optimize the local repository. "GC"

0 commit comments

Comments
 (0)