doc: explain fetchRemoteHEADWarn advice

When the user sets 'remote.<name>.followRemoteHEAD' to
'warn[-if-not-$branch]', git-fetch will report when a fetched HEAD
disagrees with the locally-configured remote's HEAD.  This additional
advice instructs the user how to deal with these warnings, but was
previously undocumented in git-config.

Signed-off-by: Matt Hunter <m@lfurio.us>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config/advice.adoc b/Documentation/config/advice.adoc
index 257db58918179a931ba42f223de30025cb7b9dca..c3c190ba6a4fb882e05ff5a34cd7a40fa814b5db 100644 (file)
--- a/Documentation/config/advice.adoc
+++ b/Documentation/config/advice.adoc
@@ -48,6 +48,10 @@ all advice messages.
                to create a local branch after the fact.
        diverging::
                Shown when a fast-forward is not possible.
+       fetchRemoteHEADWarn::
+               Shown when linkgit:git-fetch[1] reveals that a remote `HEAD`
+               differs from what is set locally and the user has opted into
+               receiving a warning in this situation.
        fetchShowForcedUpdates::
                Shown when linkgit:git-fetch[1] takes a long time
                to calculate forced updates after ref updates, or to warn