summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2025-03-12 12:06:58 -0700
committerJunio C Hamano <gitster@pobox.com>2025-03-12 12:06:58 -0700
commita867909543ed6f758148096bbdfe117c52dbdb94 (patch)
tree3178946142b0f0131ca344fe41776a9099f7c168
parent870c74987be9323012b9a55841143758fe4fccec (diff)
parent0d03fda6a5db0b56df7e629ce856d2d38c89a4de (diff)
Merge branch 'pb/doc-follow-remote-head'
Doc updates. * pb/doc-follow-remote-head: config/remote.txt: improve wording for 'remote.<name>.followRemoteHEAD' config/remote.txt: reunite 'severOption' description paragraphs
-rw-r--r--Documentation/config/remote.adoc22
1 files changed, 11 insertions, 11 deletions
diff --git a/Documentation/config/remote.adoc b/Documentation/config/remote.adoc
index 4118c219c1..25fe219d10 100644
--- a/Documentation/config/remote.adoc
+++ b/Documentation/config/remote.adoc
@@ -101,21 +101,21 @@ remote.<name>.serverOption::
The default set of server options used when fetching from this remote.
These server options can be overridden by the `--server-option=` command
line arguments.
++
+This is a multi-valued variable, and an empty value can be used in a higher
+priority configuration file (e.g. `.git/config` in a repository) to clear
+the values inherited from a lower priority configuration files (e.g.
+`$HOME/.gitconfig`).
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.
-+
-This is a multi-valued variable, and an empty value can be used in a higher
-priority configuration file (e.g. `.git/config` in a repository) to clear
-the values inherited from a lower priority configuration files (e.g.
-`$HOME/.gitconfig`).
+ 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.