From: Junio C Hamano <gitster@pobox.com>
Date: Mon, 11 Mar 2019 07:16:26 +0000 (+0900)
Subject: Merge branch 'js/rebase-recreate-merge'
X-Git-Tag: v2.22.0-rc0~148
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/a07baf33e37ddeb82778e572aea2d506d970b5ab?ds=inline;hp=-c

Merge branch 'js/rebase-recreate-merge'

Docfix.

* js/rebase-recreate-merge:
rebase docs: fix "gitlink" typo
---

a07baf33e37ddeb82778e572aea2d506d970b5ab
diff --combined Documentation/git-rebase.txt
index 5629ba4c5d,dfca489e69..6363d674b7
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@@ -8,9 -8,9 +8,9 @@@ git-rebase - Reapply commits on top of 
  SYNOPSIS
  --------
  [verse]
 -'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
 +'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
  	[<upstream> [<branch>]]
 -'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
 +'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
  	--root [<branch>]
  'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch
  
@@@ -203,7 -203,7 +203,7 @@@ Alternatively, you can undo the 'git re
  CONFIGURATION
  -------------
  
 -include::rebase-config.txt[]
 +include::config/rebase.txt[]
  
  OPTIONS
  -------
@@@ -243,15 -243,11 +243,15 @@@ leave out at most one of A and B, in wh
  --keep-empty::
  	Keep the commits that do not change anything from its
  	parents in the result.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  --allow-empty-message::
  	By default, rebasing commits with an empty message will fail.
  	This option overrides that behavior, allowing commits with empty
  	messages to be rebased.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  --skip::
  	Restart the rebasing process by skipping the current patch.
@@@ -275,8 -271,6 +275,8 @@@ branch on top of the <upstream> branch
  conflict happens, the side reported as 'ours' is the so-far rebased
  series, starting with <upstream>, and 'theirs' is the working branch.  In
  other words, the sides are swapped.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  -s <strategy>::
  --strategy=<strategy>::
@@@ -286,10 -280,8 +286,10 @@@
  +
  Because 'git rebase' replays each commit from the working branch
  on top of the <upstream> branch using the given strategy, using
 -the 'ours' strategy simply discards all patches from the <branch>,
 +the 'ours' strategy simply empties all patches from the <branch>,
  which makes little sense.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  -X <strategy-option>::
  --strategy-option=<strategy-option>::
@@@ -297,8 -289,6 +297,8 @@@
  	This implies `--merge` and, if no strategy has been
  	specified, `-s recursive`.  Note the reversal of 'ours' and
  	'theirs' as noted above for the `-m` option.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  -S[<keyid>]::
  --gpg-sign[=<keyid>]::
@@@ -334,21 -324,17 +334,21 @@@
  	and after each change.  When fewer lines of surrounding
  	context exist they all must match.  By default no context is
  	ever ignored.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
 --f::
 +--no-ff::
  --force-rebase::
 -	Force a rebase even if the current branch is up to date and
 -	the command without `--force` would return without doing anything.
 +-f::
 +	Individually replay all rebased commits instead of fast-forwarding
 +	over the unchanged ones.  This ensures that the entire history of
 +	the rebased branch is composed of new commits.
  +
 -You may find this (or --no-ff with an interactive rebase) helpful after
 -reverting a topic branch merge, as this option recreates the topic branch with
 -fresh commits so it can be remerged successfully without needing to "revert
 -the reversion" (see the
 -link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for details).
 +You may find this helpful after reverting a topic branch merge, as this option
 +recreates the topic branch with fresh commits so it can be remerged
 +successfully without needing to "revert the reversion" (see the
 +link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for
 +details).
  
  --fork-point::
  --no-fork-point::
@@@ -369,22 -355,19 +369,22 @@@ default is `--no-fork-point`, otherwis
  --whitespace=<option>::
  	These flag are passed to the 'git apply' program
  	(see linkgit:git-apply[1]) that applies the patch.
 -	Incompatible with the --interactive option.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  --committer-date-is-author-date::
  --ignore-date::
  	These flags are passed to 'git am' to easily change the dates
  	of the rebased commits (see linkgit:git-am[1]).
 -	Incompatible with the --interactive option.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  --signoff::
  	Add a Signed-off-by: trailer to all the rebased commits. Note
  	that if `--interactive` is given then only commits marked to be
 -	picked, edited or reworded will have the trailer added. Incompatible
 -	with the `--preserve-merges` option.
 +	picked, edited or reworded will have the trailer added.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  -i::
  --interactive::
@@@ -395,8 -378,6 +395,8 @@@
  The commit list format can be changed by setting the configuration option
  rebase.instructionFormat.  A customized instruction format will automatically
  have the long commit hash prepended to the format.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  -r::
  --rebase-merges[=(rebase-cousins|no-rebase-cousins)]::
@@@ -410,7 -391,7 +410,7 @@@
  +
  By default, or when `no-rebase-cousins` was specified, commits which do not
  have `<upstream>` 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 `<upstream>` (or `<onto>`, if specified).
@@@ -423,7 -404,7 +423,7 @@@ It is currently only possible to recrea
  `recursive` merge strategy; Different merge strategies can be used only via
  explicit `exec git merge -s <strategy> [...]` commands.
  +
 -See also REBASING MERGES below.
 +See also REBASING MERGES and INCOMPATIBLE OPTIONS below.
  
  -p::
  --preserve-merges::
@@@ -434,15 -415,12 +434,15 @@@
  This uses the `--interactive` machinery internally, but combining it
  with the `--interactive` option explicitly is generally not a good
  idea unless you know what you are doing (see BUGS below).
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  -x <cmd>::
  --exec <cmd>::
  	Append "exec <cmd>" after each line creating a commit in the
  	final history. <cmd> will be interpreted as one or more shell
 -	commands.
 +	commands. Any command that fails will interrupt the rebase,
 +	with exit code 1.
  +
  You may execute several commands by either using one instance of `--exec`
  with several commands:
@@@ -459,8 -437,6 +459,8 @@@ squash/fixup series
  +
  This uses the `--interactive` machinery internally, but it can be run
  without an explicit `--interactive`.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  --root::
  	Rebase all commits reachable from <branch>, instead of
@@@ -471,8 -447,6 +471,8 @@@
  	When used together with both --onto and --preserve-merges,
  	'all' root commits will be rewritten to have <newbase> as parent
  	instead.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  --autosquash::
  --no-autosquash::
@@@ -487,11 -461,11 +487,11 @@@
  	too.  The recommended way to create fixup/squash commits is by using
  	the `--fixup`/`--squash` options of linkgit:git-commit[1].
  +
 -This option is only valid when the `--interactive` option is used.
 -+
  If the `--autosquash` option is enabled by default using the
  configuration variable `rebase.autoSquash`, this option can be
  used to override and disable this setting.
 ++
 +See also INCOMPATIBLE OPTIONS below.
  
  --autostash::
  --no-autostash::
@@@ -501,69 -475,17 +501,69 @@@
  	with care: the final stash application after a successful
  	rebase might result in non-trivial conflicts.
  
 ---no-ff::
 -	With --interactive, cherry-pick all rebased commits instead of
 -	fast-forwarding over the unchanged ones.  This ensures that the
 -	entire history of the rebased branch is composed of new commits.
 -+
 -Without --interactive, this is a synonym for --force-rebase.
 -+
 -You may find this helpful after reverting a topic branch merge, as this option
 -recreates the topic branch with fresh commits so it can be remerged
 -successfully without needing to "revert the reversion" (see the
 -link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for details).
 +--reschedule-failed-exec::
 +--no-reschedule-failed-exec::
 +	Automatically reschedule `exec` commands that failed. This only makes
 +	sense in interactive mode (or when an `--exec` option was provided).
 +
 +INCOMPATIBLE OPTIONS
 +--------------------
 +
 +The following options:
 +
 + * --committer-date-is-author-date
 + * --ignore-date
 + * --whitespace
 + * --ignore-whitespace
 + * -C
 +
 +are incompatible with the following options:
 +
 + * --merge
 + * --strategy
 + * --strategy-option
 + * --allow-empty-message
 + * --[no-]autosquash
 + * --rebase-merges
 + * --preserve-merges
 + * --interactive
 + * --exec
 + * --keep-empty
 + * --edit-todo
 + * --root when used in combination with --onto
 +
 +In addition, the following pairs of options are incompatible:
 +
 + * --preserve-merges and --interactive
 + * --preserve-merges and --signoff
 + * --preserve-merges and --rebase-merges
 + * --rebase-merges and --strategy
 + * --rebase-merges and --strategy-option
 +
 +BEHAVIORAL DIFFERENCES
 +-----------------------
 +
 +There are some subtle differences how the backends behave.
 +
 +Empty commits
 +~~~~~~~~~~~~~
 +
 +The am backend drops any "empty" commits, regardless of whether the
 +commit started empty (had no changes relative to its parent to
 +start with) or ended empty (all changes were already applied
 +upstream in other commits).
 +
 +The interactive backend drops commits by default that
 +started empty and halts if it hits a commit that ended up empty.
 +The `--keep-empty` option exists for the interactive backend to allow
 +it to keep commits that started empty.
 +
 +Directory rename detection
 +~~~~~~~~~~~~~~~~~~~~~~~~~~
 +
 +Directory rename heuristics are enabled in the merge and interactive
 +backends.  Due to the lack of accurate tree information, directory
 +rename detection is disabled in the am backend.
  
  include::merge-strategies.txt[]
  
@@@ -638,9 -560,6 +638,9 @@@ By replacing the command "pick" with th
  the files and/or the commit message, amend the commit, and continue
  rebasing.
  
 +To interrupt the rebase (just like an "edit" command would do, but without
 +cherry-picking any commit first), use the "break" command.
 +
  If you just want to edit the commit message for a commit, replace the
  command "pick" with the command "reword".
  
@@@ -954,14 -873,14 +954,14 @@@ command fails, it is rescheduled immedi
  to proceed.
  
  The `reset` command resets the HEAD, index and worktree to the specified
 -revision. It is isimilar to an `exec git reset --hard <label>`, but
 +revision. It is similar to an `exec git reset --hard <label>`, but
  refuses to overwrite untracked files. If the `reset` command fails, it is
  rescheduled immediately, with a helpful message how to edit the todo list
  (this typically happens when a `reset` command was inserted into the todo
  list manually and contains a typo).
  
 -The `merge` command will merge the specified revision into whatever is
 -HEAD at that time. With `-C <original-commit>`, the commit message of
 +The `merge` command will merge the specified revision(s) into whatever
 +is HEAD at that time. With `-C <original-commit>`, the commit message of
  the specified merge commit will be used. When the `-C` is changed to
  a lower-case `-c`, the message will be opened in an editor after a
  successful merge so that the user can edit the message.
@@@ -970,8 -889,7 +970,8 @@@ If a `merge` command fails for any reas
  when the merge operation did not even start), it is rescheduled immediately.
  
  At this time, the `merge` command will *always* use the `recursive`
 -merge strategy, with no way to choose a different one. To work around
 +merge strategy for regular merges, and `octopus` for octopus merges,
 +with no way to choose a different one. To work around
  this, an `exec` command can be used to call `git merge` explicitly,
  using the fact that the labels are worktree-local refs (the ref
  `refs/rewritten/onto` would correspond to the label `onto`, for example).