threads / patch / 66657

v4doc: git-rebase: update incompatible options

Subject: [PATCH v4] doc: git-rebase: update incompatible options

## tl;dr

12 messages between Oct 25, 2026 and Nov 10, 2026. Diffs are folded; open one to read it.

replies: 11people: 4as markdown or json

Omri Sarig· Oct 25, 2026, 11:07 UTC · lore
A few options in the rebase manual page link to the "INCOMPATIBLE
OPTIONS" section, but they are 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 incompatibility references to `--ignore-date,
  --reset-author-date` and `--signoff`.

Additionally, since 414d924beb (rebase: teach rebase --keep-base, 2019-08-27) the `--onto` option is incompatible with `--keep-base`, but it is not mentioned in the INCOMPATIBLE OPTIONS section.

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

Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
---
Thank you for the review!
Changes in V2:
- Update commit message per the review comments from Phillip (Thanks for the
  review!).
- Add `--onto` to INCOMPATIBLE OPTIONS.
Changes in V3:
- Downcase "Update" in commit title
Changes in V4:
- Update the commit message per review comments.
- Rebase the patch to be compatible with the maint branch.

The main difference in git-rebase.adoc between the maintenance branch and the main branch was created in 2fc11e3382 (doc: add more AsciiDoc cross-references, 2026-09-25), which turned all the "See also..." lines into links. This created conflicts with the removed lines, which I've solved. I was not sure what is the correct way to add the new INCOMPATIBLE OPTION line in this patch. As I see it, this line can be aligned with the current version of the file (without the link), or "correct" for the final version of the file (with the link). Here, I opted to adding this line in the aligned form for the maintenance branch. This will require some work when merging this change to the main branch, as this new line will have to be updated. I was not sure if this is the correct strategy. If the right way to do it, is to add the "final" version of the line, please let me know, and I'll provide a V5.

Thank you for the support in helping me get this through.
 Documentation/git-rebase.adoc | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)
Show changes to Documentation/git-rebase.adoc +2 −6
diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc
index f6c22d1598..f1f675d311 100644
--- a/Documentation/git-rebase.adoc
+++ b/Documentation/git-rebase.adoc
@@ -217,6 +217,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 below.
 
 See TRANSPLANTING A TOPIC BRANCH WITH --ONTO above for examples.
 
@@ -332,8 +334,6 @@ See also 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 below.
 
 -m::
 --merge::
@@ -487,15 +487,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 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 below.
 
 --trailer=<trailer>::
 	Append the given trailer to every rebased commit message, processed
Tuomas Ahola· Oct 29, 2026, 08:03 UTC · re: Omri Sarig · lore

Re: [PATCH v4] doc: git-rebase: update incompatible options

[administrivia]
  Please send subsequent rerolls as direct replies to the v4 patch message
  (git send-email --in-reply-to= ).
Omri Sarig <omri.sarig13@gmail.com> wrote:
Show 12 quoted lines
> A few options in the rebase manual page link to the "INCOMPATIBLE
> OPTIONS" section, but they are 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 incompatibility references to `--ignore-date,
>   --reset-author-date` and `--signoff`.
> 

Okay. "INCOMPATIBLE OPTIONS" says nothing about "--allow-empty-message", "--ignore-date", "--reset-author-date", and "--signoff", so links from those sections to incomp opts have to go.

Well observed!
> Additionally, since 414d924beb (rebase: teach rebase --keep-base,
> 2019-08-27) the `--onto` option is incompatible with `--keep-base`, but
> it is not mentioned in the INCOMPATIBLE OPTIONS section.
> 
"--onto" is mentioned in incomp opts, but the description doesn't link there.
Just steal the correct wording from the v3 where you had it already right. :-)
Show 30 quoted lines
> Update the description of these options, to have correct references to
> the INCOMPATIBLE OPTIONS section.
> 
> Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
> ---
> 
> Thank you for the review!
> 
> Changes in V2:
> - Update commit message per the review comments from Phillip (Thanks for the
>   review!).
> - Add `--onto` to INCOMPATIBLE OPTIONS.
> 
> Changes in V3:
> - Downcase "Update" in commit title
> 
> Changes in V4:
> - Update the commit message per review comments.
> - Rebase the patch to be compatible with the maint branch.
> 
> The main difference in git-rebase.adoc between the maintenance branch and the
> main branch was created in 2fc11e3382 (doc: add more AsciiDoc cross-references,
> 2026-09-25), which turned all the "See also..." lines into links. This created
> conflicts with the removed lines, which I've solved.
> I was not sure what is the correct way to add the new INCOMPATIBLE OPTION line
> in this patch. As I see it, this line can be aligned with the current version
> of the file (without the link), or "correct" for the final version of the file
> (with the link). Here, I opted to adding this line in the aligned form for the
> maintenance branch. This will require some work when merging this change to the
> main branch, as this new line will have to be updated.

Excellent! The patch now applies cleanly to 'maint'. When this topic has settled down (i.e. merged to 'next'), you would perhaps like to send a followup patch as a separate topic. Such patch would look something like this, if you are interested:

Show changes to Documentation/git-rebase.adoc +2 −3
diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc
index 6190479966..e9c463da57 100644
--- a/Documentation/git-rebase.adoc
+++ b/Documentation/git-rebase.adoc
@@ -216,13 +216,13 @@ OPTIONS
 	existing branch name.
 +
 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 below.
+See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
 
 See <<TRANSPLANTING,TRANSPLANTING A TOPIC BRANCH WITH --ONTO>>
 above for examples.
 
 --keep-base::
 	Set the starting point at which to create the new commits to the
@@ -497,13 +497,13 @@ applying (in terms of the author date).
 
 --trailer=<trailer>::
 	Append the given trailer to every rebased commit message, processed
 	via linkgit:git-interpret-trailers[1]. This option implies
 	`--force-rebase`.
 +
-See also INCOMPATIBLE OPTIONS below.
+See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
 
 -i::
 --interactive::
 	Make a list of the commits which are about to be rebased.  Let the
 	user edit that list before rebasing.  This mode can also be used to
 	split commits (see <<SPLITTING_COMMITS,SPLITTING COMMITS>> below).


> I was not sure if this is the correct strategy. If the right way to do it, is
> to add the "final" version of the line, please let me know, and I'll provide a
> V5.
> 
> Thank you for the support in helping me get this through.
> 
>  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 f6c22d1598..f1f675d311 100644
> --- a/Documentation/git-rebase.adoc
> +++ b/Documentation/git-rebase.adoc
> @@ -217,6 +217,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 below.
>  
>  See TRANSPLANTING A TOPIC BRANCH WITH --ONTO above for examples.
>  
> @@ -332,8 +334,6 @@ See also 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 below.
>  
>  -m::
>  --merge::
> @@ -487,15 +487,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 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 below.
>  
>  --trailer=<trailer>::
>  	Append the given trailer to every rebased commit message, processed

The changes are good to go, but see my nit for the commit log message.

--Tuomas
Omri Sarig· Oct 30, 2026, 16:38 UTC · re: Omri Sarig · lore

[PATCH v5] doc: git-rebase: update incompatible options

A few options in the rebase manual page link to the "INCOMPATIBLE
OPTIONS" section, but they are 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, since 414d924beb (rebase: teach rebase --keep-base, 2019-08-27) the `--onto` option is incompatible with `--keep-base`, but doesn't link to the INCOMPATIBLE OPTIONS section.

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

Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
---
Thank you for the review!
Changes in V2:
- Update commit message per the review comments from Phillip (Thanks for the
  review!).
- Add `--onto` to INCOMPATIBLE OPTIONS.
Changes in V3:
- Downcase "Update" in commit title
Changes in V4:
- Update the commit message per review comments.
- Rebase the patch to be compatible with the maint branch.
Changes in V5:
- Update commit message, making it clear that the `--onto` option was only
  missing the INCOMPATIBLE OPTIONS link.
 Documentation/git-rebase.adoc | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)
Show changes to Documentation/git-rebase.adoc +2 −6
diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc
index f6c22d1598..f1f675d311 100644
--- a/Documentation/git-rebase.adoc
+++ b/Documentation/git-rebase.adoc
@@ -217,6 +217,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 below.
 
 See TRANSPLANTING A TOPIC BRANCH WITH --ONTO above for examples.
 
@@ -332,8 +334,6 @@ See also 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 below.
 
 -m::
 --merge::
@@ -487,15 +487,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 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 below.
 
 --trailer=<trailer>::
 	Append the given trailer to every rebased commit message, processed
Tuomas Ahola· Oct 30, 2026, 19:27 UTC · re: Omri Sarig · lore

Re: [PATCH v5] doc: git-rebase: update incompatible options

Omri Sarig <omri.sarig13@gmail.com> wrote:
Show 24 quoted lines
> A few options in the rebase manual page link to the "INCOMPATIBLE
> OPTIONS" section, but they are 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, since 414d924beb (rebase: teach rebase --keep-base,
> 2019-08-27) the `--onto` option is incompatible with `--keep-base`, but
> doesn't link to the INCOMPATIBLE OPTIONS section.
> 
> Update the description of these options, to have correct references to
> the INCOMPATIBLE OPTIONS section.
> 
> Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
> ---
> 
> Thank you for the review!
> 

The range-diff against v4 makes it clear that v5 only changed the commit message. Unfortunately, the reroll introduced a new typo:

           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 incompatibility references to `--ignore-date,
    +      removes all incompatbiilty references to `--ignore-date,
           --reset-author-date` and `--signoff`.
     
Otherwise v5 looks good to me.  Thanks!
         Additionally, since 414d924beb (rebase: teach rebase --keep-base,
         2019-08-27) the `--onto` option is incompatible with `--keep-base`, but
    -    it is not mentioned in the INCOMPATIBLE OPTIONS section.
    +    doesn't link to the INCOMPATIBLE OPTIONS section.
Junio C Hamano· Oct 30, 2026, 19:31 UTC · re: Tuomas Ahola · lore

Re: [PATCH v5] doc: git-rebase: update incompatible options

Tuomas Ahola <taahol@utu.fi> writes:
Show 14 quoted lines
>> Thank you for the review!
>> 
>
> The range-diff against v4 makes it clear that v5 only changed the commit
> message.  Unfortunately, the reroll introduced a new typo:
>
>            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 incompatibility references to `--ignore-date,
>     +      removes all incompatbiilty references to `--ignore-date,
>            --reset-author-date` and `--signoff`.
>      
> Otherwise v5 looks good to me.  Thanks!

I do not quite get what "all incompatibility references" mean, though, with or without typofixes.

Thanks.
Show 5 quoted lines
>
>          Additionally, since 414d924beb (rebase: teach rebase --keep-base,
>          2019-08-27) the `--onto` option is incompatible with `--keep-base`, but
>     -    it is not mentioned in the INCOMPATIBLE OPTIONS section.
>     +    doesn't link to the INCOMPATIBLE OPTIONS section.
Tuomas Ahola· Oct 30, 2026, 19:57 UTC · re: Junio C Hamano · lore

Re: [PATCH v5] doc: git-rebase: update incompatible options

Junio C Hamano <gitster@pobox.com> wrote:
Show 20 quoted lines
> Tuomas Ahola <taahol@utu.fi> writes:
> 
> >> Thank you for the review!
> >> 
> >
> > The range-diff against v4 makes it clear that v5 only changed the commit
> > message.  Unfortunately, the reroll introduced a new typo:
> >
> >            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 incompatibility references to `--ignore-date,
> >     +      removes all incompatbiilty references to `--ignore-date,
> >            --reset-author-date` and `--signoff`.
> >      
> > Otherwise v5 looks good to me.  Thanks!
> 
> I do not quite get what "all incompatibility references" mean,
> though, with or without typofixes.
> 
Um, yeah.  I agree.  Perhaps something like this would scan better?
- Commit a74b35081c (rebase: drop support for `--preserve-merges`,
  2021-09-07) removed the `--preserve-merges` option which was the
  only one at odds with `--ignore-date`, `--reset-author-date` and
  `--signoff`.
Show 7 quoted lines
> Thanks.
> 
> >
> >          Additionally, since 414d924beb (rebase: teach rebase --keep-base,
> >          2019-08-27) the `--onto` option is incompatible with `--keep-base`, but
> >     -    it is not mentioned in the INCOMPATIBLE OPTIONS section.
> >     +    doesn't link to the INCOMPATIBLE OPTIONS section.
Omri Sarig· Nov 1, 2026, 08:22 UTC · re: Omri Sarig · lore

[PATCH v6] doc: git-rebase: update incompatible options

A few options in the rebase manual page link to the "INCOMPATIBLE
OPTIONS" section, but they are 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 which was the
  only one at odds with `--ignore-date`, `--reset-author-date` and
  `--signoff`.

Additionally, since 414d924beb (rebase: teach rebase --keep-base, 2019-08-27) the `--onto` option is incompatible with `--keep-base`, but doesn't link to the INCOMPATIBLE OPTIONS section.

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

Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
---
Thank you for the review!
Changes in V2:
- Update commit message per the review comments from Phillip (Thanks for the
  review!).
- Add `--onto` to INCOMPATIBLE OPTIONS.
Changes in V3:
- Downcase "Update" in commit title
Changes in V4:
- Update the commit message per review comments.
- Rebase the patch to be compatible with the maint branch.
Changes in V5:
- Update commit message, making it clear that the `--onto` option was only
  missing the INCOMPATIBLE OPTIONS link.
Changes in V6:
- Update the commit message per the review comments, making it clearer.
 Documentation/git-rebase.adoc | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)
Show changes to Documentation/git-rebase.adoc +2 −6
diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc
index f6c22d1598..f1f675d311 100644
--- a/Documentation/git-rebase.adoc
+++ b/Documentation/git-rebase.adoc
@@ -217,6 +217,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 below.
 
 See TRANSPLANTING A TOPIC BRANCH WITH --ONTO above for examples.
 
@@ -332,8 +334,6 @@ See also 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 below.
 
 -m::
 --merge::
@@ -487,15 +487,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 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 below.
 
 --trailer=<trailer>::
 	Append the given trailer to every rebased commit message, processed
Omri Sarig· Nov 9, 2026, 17:23 UTC · re: Omri Sarig · lore

Re: [PATCH v6] doc: git-rebase: update incompatible options

On 01/11/2026 09.22, Omri Sarig wrote:
Show 79 quoted lines
> A few options in the rebase manual page link to the "INCOMPATIBLE
> OPTIONS" section, but they are 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 which was the
>    only one at odds with `--ignore-date`, `--reset-author-date` and
>    `--signoff`.
>
> Additionally, since 414d924beb (rebase: teach rebase --keep-base,
> 2019-08-27) the `--onto` option is incompatible with `--keep-base`, but
> doesn't link to the INCOMPATIBLE OPTIONS section.
>
> Update the description of these options, to have correct references to
> the INCOMPATIBLE OPTIONS section.
>
> Signed-off-by: Omri Sarig <omri.sarig13@gmail.com>
> ---
>
> Thank you for the review!
>
> Changes in V2:
> - Update commit message per the review comments from Phillip (Thanks for the
>    review!).
> - Add `--onto` to INCOMPATIBLE OPTIONS.
>
> Changes in V3:
> - Downcase "Update" in commit title
>
> Changes in V4:
> - Update the commit message per review comments.
> - Rebase the patch to be compatible with the maint branch.
>
> Changes in V5:
> - Update commit message, making it clear that the `--onto` option was only
>    missing the INCOMPATIBLE OPTIONS link.
>
> Changes in V6:
> - Update the commit message per the review comments, making it clearer.
>
>   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 f6c22d1598..f1f675d311 100644
> --- a/Documentation/git-rebase.adoc
> +++ b/Documentation/git-rebase.adoc
> @@ -217,6 +217,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 below.
>   >   See TRANSPLANTING A TOPIC BRANCH WITH --ONTO above for examples.
>   > @@ -332,8 +334,6 @@ See also 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 below.
>   >   -m::
>   --merge::
> @@ -487,15 +487,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 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 below.
>   >   --trailer=<trailer>::
>   	Append the given trailer to every rebased commit message, processed
Hi,
This patch has been sitting around for some time without a review.

Anyone that is interested in reviewing it? Anything more I can do from my side to help this process?

Thanks! Omri

Julia Evans· Nov 10, 2026, 14:06 UTC · re: Omri Sarig · lore

Re: [PATCH v6] doc: git-rebase: update incompatible options

Show 6 quoted lines
> @@ -217,6 +217,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 below.

Elsewhere in the document we're now linking to the section like this, since 2fc11e33820:

See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
I think it would be good to keep things consistent.

Also it would be good to try to convert up all remaining internal links that aren't using the << >>, I may try to do that at some point.

Omri Sarig· Nov 10, 2026, 15:37 UTC · re: Julia Evans · lore

Re: [PATCH v6] doc: git-rebase: update incompatible options

On 10/11/2026 15.06, Julia Evans wrote:
Show 6 quoted lines
>> @@ -217,6 +217,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 below.
Thank you for looking at it!
> Elsewhere in the document we're now linking to the section like this,
> since 2fc11e33820:
As per Junio's request (https://lore.kernel.org/git/xmqqjyncxrur.fsf@gitster.g/), the current version is built over the 'maint' branch, and therefore does not have 2fc11e33820 available yet.

I've discussed  whether this update should include the links, or not include them, and understood from Tuomas that the right way to do it here, is to keep the file consistent with itself in the maintenance branch version of it, and update the links everywhere in a future patch (discussed here: https://lore.kernel.org/git/20261029080317.wWchf%25taahol@utu.fi/). Additionally, the INCOMPATIBLE OPTIONS section cannot be a target to a link yet, so this won't apply cleanly to the 'maint' branch with these links.

Please let me know if I should update these links, or keep them consistent with the rest of the file in the 'maint' branch.
Show 7 quoted lines
>
> See also <<INCOMPATIBLE_OPTIONS,INCOMPATIBLE OPTIONS>> below.
>
> I think it would be good to keep things consistent.
>
> Also it would be good to try to convert up all remaining internal links that
> aren't using the << >>, I may try to do that at some point.
As far as I can see, the only place that does not have a link to the INCOMPATIBLE OPTIONS section in the master branch is the --trailer option.
If you want me to, I'll happily update the added section, together with the trailer options, once both are merge.

Thanks, Omri

Julia Evans· Nov 10, 2026, 17:59 UTC · re: Omri Sarig · lore

Re: [PATCH v6] doc: git-rebase: update incompatible options

Show 22 quoted lines
>>> +See also INCOMPATIBLE OPTIONS below.
> Thank you for looking at it!
>> Elsewhere in the document we're now linking to the section like this,
>> since 2fc11e33820:
>
> As per Junio's request 
> (https://lore.kernel.org/git/xmqqjyncxrur.fsf@gitster.g/), the current 
> version is built over the 'maint' branch, and therefore does not have 
> 2fc11e33820 available yet.
>
> I've discussed  whether this update should include the links, or not 
> include them, and understood from Tuomas that the right way to do it 
> here, is to keep the file consistent with itself in the maintenance 
> branch version of it, and update the links everywhere in a future patch 
> (discussed here: 
> https://lore.kernel.org/git/20261029080317.wWchf%25taahol@utu.fi/).
> Additionally, the INCOMPATIBLE OPTIONS section cannot be a target to a 
> link yet, so this won't apply cleanly to the 'maint' branch with these 
> links.
>
> Please let me know if I should update these links, or keep them 
> consistent with the rest of the file in the 'maint' branch.

Ah, I hadn't read that part of the thread, sorry about that! I'm not familiar with the process around the `maint` branch so I definitely don't have opinions about how that should work.

Thanks for explaining it!
Junio C Hamano· Nov 10, 2026, 18:10 UTC · re: Omri Sarig · lore

Re: [PATCH v6] doc: git-rebase: update incompatible options

Omri Sarig <omri.sarig13@gmail.com> writes:
Show 44 quoted lines
> Changes in V6:
> - Update the commit message per the review comments, making it clearer.
>
>  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 f6c22d1598..f1f675d311 100644
> --- a/Documentation/git-rebase.adoc
> +++ b/Documentation/git-rebase.adoc
> @@ -217,6 +217,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 below.
>  
>  See TRANSPLANTING A TOPIC BRANCH WITH --ONTO above for examples.
>  
> @@ -332,8 +334,6 @@ See also 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 below.
>  
>  -m::
>  --merge::
> @@ -487,15 +487,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 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 below.
>  
>  --trailer=<trailer>::
>  	Append the given trailer to every rebased commit message, processed
Looking good.  Let's mark it as ready for 'next'.

← back to recent threads