Skip to content

Commit 627a129

Browse files
avargitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent d0e0747 commit 627a129

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

Documentation/config.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1398,7 +1398,8 @@ fetch.unpackLimit::
13981398

13991399
fetch.prune::
14001400
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].
14021403

14031404
fetch.output::
14041405
Control how ref update status is printed. Valid values are
@@ -2944,6 +2945,9 @@ remote.<name>.prune::
29442945
remove any remote-tracking references that no longer exist on the
29452946
remote (as if the `--prune` option was given on the command line).
29462947
Overrides `fetch.prune` settings, if any.
2948+
+
2949+
See also `remote.<name>.prune` and the PRUNING section of
2950+
linkgit:git-fetch[1].
29472951

29482952
remotes.<group>::
29492953
The list of remotes which are fetched by "git remote update

Documentation/fetch-options.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ ifndef::git-pull[]
7474
line or in the remote configuration, for example if the remote
7575
was cloned with the --mirror option), then they are also
7676
subject to pruning.
77+
+
78+
See the PRUNING section below for more details.
79+
7780
endif::git-pull[]
7881

7982
ifndef::git-pull[]

0 commit comments

Comments
 (0)