Skip to content

Commit

Permalink
rebase: clarify --reschedule-failed-exec default
Browse files Browse the repository at this point in the history
Documentation should mention the default behavior.

It is better to explain the persistent nature of the
--reschedule-failed-exec flag from the user standpoint, rather than from
the implementation standpoint.

Signed-off-by: Illia Bobyr <[email protected]>
Signed-off-by: Junio C Hamano <[email protected]>
  • Loading branch information
ilya-bobyr authored and gitster committed Jan 5, 2024
1 parent 564d025 commit 25aec06
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions Documentation/git-rebase.txt
Original file line number Diff line number Diff line change
Expand Up @@ -620,13 +620,16 @@ See also INCOMPATIBLE OPTIONS below.
Automatically reschedule `exec` commands that failed. This only makes
sense in interactive mode (or when an `--exec` option was provided).
+
Even though this option applies once a rebase is started, it's set for
the whole rebase at the start based on either the
`rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1]
or "CONFIGURATION" below) or whether this option is
provided. Otherwise an explicit `--no-reschedule-failed-exec` at the
start would be overridden by the presence of
`rebase.rescheduleFailedExec=true` configuration.
This option applies once a rebase is started. It is preserved for the whole
rebase based on, in order, the command line option provided to the initial `git
rebase`, the `rebase.rescheduleFailedExec` configuration (see
linkgit:git-config[1] or "CONFIGURATION" below), or it defaults to false.
+
Recording this option for the whole rebase is a convenience feature. Otherwise
an explicit `--no-reschedule-failed-exec` at the start would be overridden by
the presence of a `rebase.rescheduleFailedExec=true` configuration when `git
rebase --continue` is invoked. Currently, you cannot pass
`--[no-]reschedule-failed-exec` to `git rebase --continue`.

--update-refs::
--no-update-refs::
Expand Down

0 comments on commit 25aec06

Please sign in to comment.