[PATCH v2] doc: git-rebase: Update incompatible options

[PATCH v2] doc: git-rebase: Update incompatible options

[Omri Sarig]

Several options in the rebase man page link to the "INCOMPATIBLE
OPTIONS" section when the option is no-longer incompatible with any
other option.

- Commit 1a66d8c6f6 (rebase: remove --allow-empty-message from
  incompatible opts, 2023-01-25) removed "--allow-empty-message" from
  the INCOMPATIBLE OPTIONS section, but did not remove the link to that
  section from the option description.
- Commit a74b35081c (rebase: drop support for `--preserve-merges`,
  2021-09-07) removed the `--preserve-merges` option from rebase, which
  removes all incompatbiilty references to `--ignore-date,
  --reset-author-date` and `--signoff`.

Additionally, `--onto` doesn't link to the INCOMPATIBLE OPTIONS section, even
though it is incompatible with `--keep-base`.

Update the description of these option, to have correct references to
the INCOMPATIBLE OPTIONS section.

Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
---

Changes in V2:
- Update commit message per the review comments from Phillip (Thanks for the
  review!).
- Add `--onto` to INCOMPATIEBLE OPTIONS.

I was not sure if both adding INCOMPATIBLE OPTIONS (--onto) and removing them
(the other flags) belong in the same commit, or in 2 separate commits. These
changes felt small enough to me to not require a second commit, but please let
me know if it's preferred. I'll happily send a new patch where these changes
are split across different commits.

 Documentation/git-rebase.adoc | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)

diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc
index 6536ebdc90..6363b1a096 100644
--- a/Documentation/git-rebase.adoc
+++ b/Documentation/git-rebase.adoc
@@ -218,6 +218,8 @@ OPTIONS
 As a special case, you may use "A\...B" as a shortcut for the
 merge base of A and B if there is exactly one merge base. You can
 leave out at most one of A and B, in which case it defaults to HEAD.
++
+See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
 
 See <<TRANSPLANTING,TRANSPLANTING A TOPIC BRANCH WITH --ONTO>>
 above for examples.
@@ -334,8 +336,6 @@ See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
 	and this option would override that behavior, allowing commits
 	with empty messages to be rebased.  Now commits with an empty
 	message do not cause rebasing to halt.
-+
-See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
 
 -m::
 --merge::
@@ -489,15 +489,11 @@ applying (in terms of the author date).
 	Instead of using the author date of the original commit, use
 	the current time as the	author date of the rebased commit.  This
 	option implies `--force-rebase`.
-+
-See also <<INCOMPATIBLE_OPTIONS,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.
-+
-See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
 
 --trailer=<trailer>::
 	Append the given trailer to every rebased commit message, processed

Range-diff against v1:
1:  27c94f5ff4 = 1:  27c94f5ff4 doc: git-rebase: Update incompatible options

Re: [PATCH v2] doc: git-rebase: Update incompatible options

[Junio C Hamano]

Omri Sarig <omri.sarig13@gmail.com> writes:

> Subject: Re: [PATCH v2] doc: git-rebase: Update incompatible options

Downcase "Update" here.

> Several options in the rebase man page link to the "INCOMPATIBLE
> OPTIONS" section when the option is no-longer incompatible with any
> other option.
>
> - Commit 1a66d8c6f6 (rebase: remove --allow-empty-message from
>   incompatible opts, 2023-01-25) removed "--allow-empty-message" from
>   the INCOMPATIBLE OPTIONS section, but did not remove the link to that
>   section from the option description.
> - Commit a74b35081c (rebase: drop support for `--preserve-merges`,
>   2021-09-07) removed the `--preserve-merges` option from rebase, which
>   removes all incompatbiilty references to `--ignore-date,
>   --reset-author-date` and `--signoff`.
>
> Additionally, `--onto` doesn't link to the INCOMPATIBLE OPTIONS section, even
> though it is incompatible with `--keep-base`.
>
> Update the description of these option, to have correct references to
> the INCOMPATIBLE OPTIONS section.
>
> Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
> ---

> I was not sure if both adding INCOMPATIBLE OPTIONS (--onto) and removing them
> (the other flags) belong in the same commit, or in 2 separate commits. These
> changes felt small enough to me to not require a second commit, but please let
> me know if it's preferred. I'll happily send a new patch where these changes
> are split across different commits.

They both fall into "update the stale list of incompatible options
to code's reality", which the title of the patch claims to do, so I
see no issues there.

Re: [PATCH v2] doc: git-rebase: Update incompatible options

[Phillip Wood]

Hi Omri

Thanks for re-rolling - I don't have anything to add to Junios comments 
on this version

Thanks

Phillip

On 19/10/2026 15:35, Omri Sarig wrote:
> Several options in the rebase man page link to the "INCOMPATIBLE
> OPTIONS" section when the option is no-longer incompatible with any
> other option.
> 
> - Commit 1a66d8c6f6 (rebase: remove --allow-empty-message from
>    incompatible opts, 2023-01-25) removed "--allow-empty-message" from
>    the INCOMPATIBLE OPTIONS section, but did not remove the link to that
>    section from the option description.
> - Commit a74b35081c (rebase: drop support for `--preserve-merges`,
>    2021-09-07) removed the `--preserve-merges` option from rebase, which
>    removes all incompatbiilty references to `--ignore-date,
>    --reset-author-date` and `--signoff`.
> 
> Additionally, `--onto` doesn't link to the INCOMPATIBLE OPTIONS section, even
> though it is incompatible with `--keep-base`.
> 
> Update the description of these option, to have correct references to
> the INCOMPATIBLE OPTIONS section.
> 
> Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
> ---
> 
> Changes in V2:
> - Update commit message per the review comments from Phillip (Thanks for the
>    review!).
> - Add `--onto` to INCOMPATIEBLE OPTIONS.
> 
> I was not sure if both adding INCOMPATIBLE OPTIONS (--onto) and removing them
> (the other flags) belong in the same commit, or in 2 separate commits. These
> changes felt small enough to me to not require a second commit, but please let
> me know if it's preferred. I'll happily send a new patch where these changes
> are split across different commits.
> 
>   Documentation/git-rebase.adoc | 8 ++------
>   1 file changed, 2 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc
> index 6536ebdc90..6363b1a096 100644
> --- a/Documentation/git-rebase.adoc
> +++ b/Documentation/git-rebase.adoc
> @@ -218,6 +218,8 @@ OPTIONS
>   As a special case, you may use "A\...B" as a shortcut for the
>   merge base of A and B if there is exactly one merge base. You can
>   leave out at most one of A and B, in which case it defaults to HEAD.
> ++
> +See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
>   
>   See <<TRANSPLANTING,TRANSPLANTING A TOPIC BRANCH WITH --ONTO>>
>   above for examples.
> @@ -334,8 +336,6 @@ See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
>   	and this option would override that behavior, allowing commits
>   	with empty messages to be rebased.  Now commits with an empty
>   	message do not cause rebasing to halt.
> -+
> -See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
>   
>   -m::
>   --merge::
> @@ -489,15 +489,11 @@ applying (in terms of the author date).
>   	Instead of using the author date of the original commit, use
>   	the current time as the	author date of the rebased commit.  This
>   	option implies `--force-rebase`.
> -+
> -See also <<INCOMPATIBLE_OPTIONS,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.
> -+
> -See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
>   
>   --trailer=<trailer>::
>   	Append the given trailer to every rebased commit message, processed
> 
> Range-diff against v1:
> 1:  27c94f5ff4 = 1:  27c94f5ff4 doc: git-rebase: Update incompatible options