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>
Matt Hunter committed
Jun 19, 2026 at 05:44 UTC
54c9d481011b095561099393ac3ef4828de4a329
1 file changed
+4
Documentation/config/advice.adoc
+4
index 257db58918..c3c190ba6a 100644
--- 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