1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-10-28 21:07:52 +01:00

rebase: clarify --reschedule-failed-exec default

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 <illia.bobyr@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Illia Bobyr 2024-01-04 17:14:26 -08:00 committed by Junio C Hamano
parent 564d0252ca
commit 25aec06326

View file

@ -620,13 +620,16 @@ See also INCOMPATIBLE OPTIONS below.
Automatically reschedule `exec` commands that failed. This only makes Automatically reschedule `exec` commands that failed. This only makes
sense in interactive mode (or when an `--exec` option was provided). 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 This option applies once a rebase is started. It is preserved for the whole
the whole rebase at the start based on either the rebase based on, in order, the command line option provided to the initial `git
`rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1] rebase`, the `rebase.rescheduleFailedExec` configuration (see
or "CONFIGURATION" below) or whether this option is linkgit:git-config[1] or "CONFIGURATION" below), or it defaults to false.
provided. Otherwise an explicit `--no-reschedule-failed-exec` at the +
start would be overridden by the presence of Recording this option for the whole rebase is a convenience feature. Otherwise
`rebase.rescheduleFailedExec=true` configuration. 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:: --update-refs::
--no-update-refs:: --no-update-refs::