From: Junio C Hamano Date: Tue, 9 Jul 2019 22:25:38 +0000 (-0700) Subject: Merge branch 'pw/doc-synopsis-markup-opmode-options' X-Git-Tag: v2.23.0-rc0~80 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/0af6d5dd062909eee3762e5fdec873ba6e7754b4?ds=inline;hp=-c Merge branch 'pw/doc-synopsis-markup-opmode-options' Docfix. * pw/doc-synopsis-markup-opmode-options: show --continue/skip etc. consistently in synopsis --- 0af6d5dd062909eee3762e5fdec873ba6e7754b4 diff --combined Documentation/git-merge.txt index c01cfa6595,926ea4f460..3ff0393507 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@@ -13,8 -13,7 +13,7 @@@ SYNOPSI [-s ] [-X ] [-S[]] [--[no-]allow-unrelated-histories] [--[no-]rerere-autoupdate] [-m ] [-F ] [...] - 'git merge' --abort - 'git merge' --continue + 'git merge' (--continue | --abort | --quit) DESCRIPTION ----------- @@@ -83,8 -82,7 +82,8 @@@ invocations. The automated message can If `--log` is specified, a shortlog of the commits being merged will be appended to the specified message. ---[no-]rerere-autoupdate:: +--rerere-autoupdate:: +--no-rerere-autoupdate:: Allow the rerere mechanism to update the index with the result of auto-conflict resolution if possible. diff --combined Documentation/git-rebase.txt index 5e4e927647,a67d40596a..057c21d8ee --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@@ -12,7 -12,7 +12,7 @@@ SYNOPSI [ []] 'git rebase' [-i | --interactive] [] [--exec ] [--onto ] --root [] - 'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch + 'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch) DESCRIPTION ----------- @@@ -300,11 -300,6 +300,11 @@@ See also INCOMPATIBLE OPTIONS below + See also INCOMPATIBLE OPTIONS below. +--rerere-autoupdate:: +--no-rerere-autoupdate:: + Allow the rerere mechanism to update the index with the + result of auto-conflict resolution if possible. + -S[]:: --gpg-sign[=]:: GPG-sign commits. The `keyid` argument is optional and @@@ -415,14 -410,14 +415,14 @@@ See also INCOMPATIBLE OPTIONS below + By default, or when `no-rebase-cousins` was specified, commits which do not have `` as direct ancestor will keep their original branch point, -i.e. commits that would be excluded by gitlink:git-log[1]'s +i.e. commits that would be excluded by linkgit:git-log[1]'s `--ancestry-path` option will keep their original ancestry by default. If the `rebase-cousins` mode is turned on, such commits are instead rebased onto `` (or ``, if specified). + -The `--rebase-merges` mode is similar in spirit to `--preserve-merges`, but -in contrast to that option works well in interactive rebases: commits can be -reordered, inserted and dropped at will. +The `--rebase-merges` mode is similar in spirit to the deprecated +`--preserve-merges`, but in contrast to that option works well in interactive +rebases: commits can be reordered, inserted and dropped at will. + It is currently only possible to recreate the merge commits using the `recursive` merge strategy; Different merge strategies can be used only via @@@ -432,10 -427,9 +432,10 @@@ See also REBASING MERGES and INCOMPATIB -p:: --preserve-merges:: - Recreate merge commits instead of flattening the history by replaying - commits a merge commit introduces. Merge conflict resolutions or manual - amendments to merge commits are not preserved. + [DEPRECATED: use `--rebase-merges` instead] Recreate merge commits + instead of flattening the history by replaying commits a merge commit + introduces. Merge conflict resolutions or manual amendments to merge + commits are not preserved. + This uses the `--interactive` machinery internally, but combining it with the `--interactive` option explicitly is generally not a good @@@ -675,8 -669,7 +675,8 @@@ $ git rebase -i HEAD~ And move the first patch to the end of the list. -You might want to preserve merges, if you have a history like this: +You might want to recreate merge commits, e.g. if you have a history +like this: ------------------ X @@@ -690,7 -683,7 +690,7 @@@ Suppose you want to rebase the side bra sure that the current HEAD is "B", and call ----------------------------- -$ git rebase -i -p --onto Q O +$ git rebase -i -r --onto Q O ----------------------------- Reordering and editing commits usually creates untested intermediate @@@ -1027,11 -1020,11 +1027,11 @@@ merge cmak BUGS ---- -The todo list presented by `--preserve-merges --interactive` does not -represent the topology of the revision graph. Editing commits and -rewording their commit messages should work fine, but attempts to -reorder commits tend to produce counterintuitive results. Use -`--rebase-merges` in such scenarios instead. +The todo list presented by the deprecated `--preserve-merges --interactive` +does not represent the topology of the revision graph (use `--rebase-merges` +instead). Editing commits and rewording their commit messages should work +fine, but attempts to reorder commits tend to produce counterintuitive results. +Use `--rebase-merges` in such scenarios instead. For example, an attempt to rearrange ------------