Skip to content

Commit 6fcbad8

Browse files
j6tgitster
authored andcommitted
rebase docs: fix incorrect format of the section Behavioral Differences
The text body of section Behavioral Differences is typeset as code, but should be regular text. Remove the indentation to achieve that. While here, prettify the language: - use "the x backend" instead of "x-based rebase"; - use present tense instead of future tense; and use subsections instead of a list. Signed-off-by: Johannes Sixt <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent b00bf1c commit 6fcbad8

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

Documentation/git-rebase.txt

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -549,24 +549,28 @@ Other incompatible flag pairs:
549549
BEHAVIORAL DIFFERENCES
550550
-----------------------
551551

552-
* empty commits:
552+
There are some subtle differences how the backends behave.
553553

554-
am-based rebase will drop any "empty" commits, whether the
555-
commit started empty (had no changes relative to its parent to
556-
start with) or ended empty (all changes were already applied
557-
upstream in other commits).
554+
Empty commits
555+
~~~~~~~~~~~~~
556+
557+
The am backend drops any "empty" commits, regardless of whether the
558+
commit started empty (had no changes relative to its parent to
559+
start with) or ended empty (all changes were already applied
560+
upstream in other commits).
558561

559-
merge-based rebase does the same.
562+
The merge backend does the same.
560563

561-
interactive-based rebase will by default drop commits that
562-
started empty and halt if it hits a commit that ended up empty.
563-
The `--keep-empty` option exists for interactive rebases to allow
564-
it to keep commits that started empty.
564+
The interactive backend drops commits by default that
565+
started empty and halts if it hits a commit that ended up empty.
566+
The `--keep-empty` option exists for the interactive backend to allow
567+
it to keep commits that started empty.
565568

566-
* directory rename detection:
569+
Directory rename detection
570+
~~~~~~~~~~~~~~~~~~~~~~~~~~
567571

568-
merge-based and interactive-based rebases work fine with
569-
directory rename detection. am-based rebases sometimes do not.
572+
The merge and interactive backends work fine with
573+
directory rename detection. The am backend sometimes does not.
570574

571575
include::merge-strategies.txt[]
572576

0 commit comments

Comments
 (0)