[PATCH] Documentation/config.txt: change "pull.rebase" description in favor of safer 'preserve' option.
- From
Sergey Organov <sorganov@gmail.com>
- Date
- Aug 5, 2014, 10:58 UTC
- Message-ID
- <87bnrzxhrm.fsf@osv.gnss.ru>
Previous description implicitly favored 'true' value for "pull.rebase" and "pull.<branch>.rebase" options, when for some workflows 'preserve' is the right choice, and for others it hardly makes any difference. Therefore, 'preserve' should be preferred in general, unless the user knows exactly what she is doing.
Signed-off-by: Sergey Organov <sorganov@gmail.com> --- Documentation/config.txt | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt index c55c22a..30f28d9 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -772,14 +772,13 @@ branch.<name>.mergeoptions:: supported. branch.<name>.rebase:: - When true, rebase the branch <name> on top of the fetched branch, - instead of merging the default branch from the default remote when - "git pull" is run. See "pull.rebase" for doing this in a non - branch-specific manner. + When `preserve` or `true`, rebase the branch <name> on top of the + fetched branch, instead of merging the default branch from the + default remote when 'git pull' is run. See "pull.rebase" for + doing this in a non branch-specific manner. + - When preserve, also pass `--preserve-merges` along to 'git rebase' - so that locally committed merge commits will not be flattened - by running 'git pull'. + When `true`, do not pass `--preserve-merges` to 'git rebase', so + that local merge commits will be flattened by running 'git pull'. + *NOTE*: this is a possibly dangerous operation; do *not* use it unless you understand the implications (see linkgit:git-rebase[1] @@ -1948,14 +1947,13 @@ pull.ff:: command line). pull.rebase:: - When true, rebase branches on top of the fetched branch, instead - of merging the default branch from the default remote when "git - pull" is run. See "branch.<name>.rebase" for setting this on a - per-branch basis. + When `preserve` or `true`, rebase branches on top of the + fetched branch, instead of merging the default branch from the + default remote when 'git pull' is run. See + "branch.<name>.rebase" for setting this on a per-branch basis. + - When preserve, also pass `--preserve-merges` along to 'git rebase' - so that locally committed merge commits will not be flattened - by running 'git pull'. + When `true`, do not pass `--preserve-merges` to 'git rebase', so + that local merge commits will be flattened by running 'git pull'. + *NOTE*: this is a possibly dangerous operation; do *not* use it unless you understand the implications (see linkgit:git-rebase[1]
-- 1.9.3