undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-fetch & config doc: link to the new PRUNING section

Browse Source 
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>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2018-02-09 20:32:13 +00:00 committed by Junio C Hamano
parent d0e07472fa
commit 627a129b46
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/config.txt
View File

@ -1398,7 +1398,8 @@ fetch.unpackLimit::
fetch.prune:: fetch.prune::
If true, fetch will automatically behave as if the `--prune` If true, fetch will automatically behave as if the `--prune`
option was given on the command line. See also `remote.<name>.prune`. option was given on the command line. See also `remote.<name>.prune`
and the PRUNING section of linkgit:git-fetch[1].
fetch.output:: fetch.output::
Control how ref update status is printed. Valid values are Control how ref update status is printed. Valid values are
@ -2944,6 +2945,9 @@ remote.<name>.prune::
remove any remote-tracking references that no longer exist on the remove any remote-tracking references that no longer exist on the
remote (as if the `--prune` option was given on the command line). remote (as if the `--prune` option was given on the command line).
Overrides `fetch.prune` settings, if any. Overrides `fetch.prune` settings, if any.
+
See also `remote.<name>.prune` and the PRUNING section of
linkgit:git-fetch[1].
remotes.<group>:: remotes.<group>::
The list of remotes which are fetched by "git remote update The list of remotes which are fetched by "git remote update

3
Documentation/fetch-options.txt
View File

@ -74,6 +74,9 @@ ifndef::git-pull[]
line or in the remote configuration, for example if the remote line or in the remote configuration, for example if the remote
was cloned with the --mirror option), then they are also was cloned with the --mirror option), then they are also
subject to pruning. subject to pruning.
+
See the PRUNING section below for more details.
endif::git-pull[] endif::git-pull[]
ifndef::git-pull[] ifndef::git-pull[]