git-fetch & config doc: link to the new PRUNING section
Amend the documentation for fetch.prune, fetch.<name>.prune and --prune to link to the recently added PRUNING section. I'd have liked to link directly to it with "<<PRUNING>>" from fetch-options.txt, since it's included in git-fetch.txt (git-pull.txt also includes it, but doesn't include that option). However making a reference across files yields this error: [...]/Documentation/git-fetch.xml:226: element xref: validity error : IDREF attribute linkend references an unknown ID "PRUNING" Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Feb 9, 2018 at 20:32 UTC
627a129b46530773369586f7982925fd41dc7227
2 files changed
+8
-1
Documentation/config.txt
+5
-1
@@ -1398,7 +1398,8 @@ fetch.unpackLimit::
1398
1399
fetch.prune::
1400
If true, fetch will automatically behave as if the `--prune`
1401
- option was given on the command line. See also `remote.<name>.prune`.
1401
+ option was given on the command line. See also `remote.<name>.prune`
1402
+ and the PRUNING section of linkgit:git-fetch[1].
1403
1404
fetch.output::
1405
Control how ref update status is printed. Valid values are
@@ -2944,6 +2945,9 @@ remote.<name>.prune::
2945
remove any remote-tracking references that no longer exist on the
2946
remote (as if the `--prune` option was given on the command line).
2947
Overrides `fetch.prune` settings, if any.
2948
++
2949
+See also `remote.<name>.prune` and the PRUNING section of
2950
+linkgit:git-fetch[1].
2951
2952
remotes.<group>::
2953
The list of remotes which are fetched by "git remote update
Documentation/fetch-options.txt
+3
@@ -74,6 +74,9 @@ ifndef::git-pull[]
74
line or in the remote configuration, for example if the remote
75
was cloned with the --mirror option), then they are also
76
subject to pruning.
77
++
78
+See the PRUNING section below for more details.
79
+
80
endif::git-pull[]
81
82
ifndef::git-pull[]