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>
Junio C Hamano committed
Sep 9, 2024 at 08:53 UTC
9a36ea37aea99750dbe05c6ef36a9e02722f5a07
3 files changed
+13
-8
Documentation/config/remote.txt
+7
-6
@@ -42,14 +42,15 @@ remote.<name>.mirror::
42
as if the `--mirror` option was given on the command line.
43
44
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).
48
49
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`.
54
55
remote.<name>.receivepack::
56
The default program to execute on the remote side when pushing. See
Documentation/fetch-options.txt
+3
-2
@@ -1,6 +1,7 @@
1
--[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`.
5
6
-a::
7
--append::
Documentation/git-maintenance.txt
+3
@@ -107,6 +107,9 @@ with the prefetch task, the objects necessary to complete a later real fetch
107
would already be obtained, making the real fetch faster. In the ideal case,
108
it will just become an update to a bunch of remote-tracking branches without
109
any object transfer.
110
++
111
+The `remote.<name>.skipFetchAll` configuration can be used to
112
+exclude a particular remote from getting prefetched.
113
114
gc::
115
Clean up unnecessary files and optimize the local repository. "GC"