Skip to content

Commit a867909

Browse files
committed
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
2 parents 870c749 + 0d03fda commit a867909

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Documentation/config/remote.adoc

+11-11
Original file line numberDiff line numberDiff line change
@@ -101,21 +101,21 @@ remote.<name>.serverOption::
101101
The default set of server options used when fetching from this remote.
102102
These server options can be overridden by the `--server-option=` command
103103
line arguments.
104+
+
105+
This is a multi-valued variable, and an empty value can be used in a higher
106+
priority configuration file (e.g. `.git/config` in a repository) to clear
107+
the values inherited from a lower priority configuration files (e.g.
108+
`$HOME/.gitconfig`).
104109

105110
remote.<name>.followRemoteHEAD::
106111
How linkgit:git-fetch[1] should handle updates to `remotes/<name>/HEAD`.
107112
The default value is "create", which will create `remotes/<name>/HEAD`
108-
if it exists on the remote, but not locally, but will not touch an
109-
already existing local reference. Setting to "warn" will print
110-
a message if the remote has a different value, than the local one and
113+
if it exists on the remote, but not locally; this will not touch an
114+
already existing local reference. Setting it to "warn" will print
115+
a message if the remote has a different value than the local one;
111116
in case there is no local reference, it behaves like "create".
112117
A variant on "warn" is "warn-if-not-$branch", which behaves like
113118
"warn", but if `HEAD` on the remote is `$branch` it will be silent.
114-
Setting to "always" will silently update it to the value on the remote.
115-
Finally, setting it to "never" will never change or create the local
116-
reference.
117-
+
118-
This is a multi-valued variable, and an empty value can be used in a higher
119-
priority configuration file (e.g. `.git/config` in a repository) to clear
120-
the values inherited from a lower priority configuration files (e.g.
121-
`$HOME/.gitconfig`).
119+
Setting it to "always" will silently update `remotes/<name>/HEAD` to
120+
the value on the remote. Finally, setting it to "never" will never
121+
change or create the local reference.

0 commit comments

Comments
 (0)