config/remote.txt: improve wording for 'remote.<name>.followRemoteHEAD'

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Philippe Blain
2025-02-14 17:36:18 +00:00
committed by Junio C Hamano
parent aaf8f79c67
commit 0d03fda6a5

View File

@@ -110,12 +110,12 @@ the values inherited from a lower priority configuration files (e.g.
remote.<name>.followRemoteHEAD::
How linkgit:git-fetch[1] should handle updates to `remotes/<name>/HEAD`.
The default value is "create", which will create `remotes/<name>/HEAD`
if it exists on the remote, but not locally, but will not touch an
already existing local reference. Setting to "warn" will print
a message if the remote has a different value, than the local one and
if it exists on the remote, but not locally; this will not touch an
already existing local reference. Setting it to "warn" will print
a message if the remote has a different value than the local one;
in case there is no local reference, it behaves like "create".
A variant on "warn" is "warn-if-not-$branch", which behaves like
"warn", but if `HEAD` on the remote is `$branch` it will be silent.
Setting to "always" will silently update it to the value on the remote.
Finally, setting it to "never" will never change or create the local
reference.
Setting it to "always" will silently update `remotes/<name>/HEAD` to
the value on the remote. Finally, setting it to "never" will never
change or create the local reference.