From: Johannes Sixt <j6t@kdbg.org>
To: Git Mailing List <git@vger.kernel.org>
Subject: [PATCH] rebase docs: fix incorrect format of the section Behavioral Differences
Date: Mon, 3 Dec 2018 18:34:49 +0100 [thread overview]
Message-ID: <f26b53e3-e7d1-f0fe-cdd3-dd734beb1628@kdbg.org> (raw)
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 <j6t@kdbg.org>
---
Cf. https://git-scm.com/docs/git-rebase#_behavioral_differences
I actually did not test the result, because I don't have the
infrastructure.
The sentence "The am backend sometimes does not" is not very useful,
but is not my fault ;) It would be great if it could be made more
specific, but I do not know the details.
Documentation/git-rebase.txt | 30 +++++++++++++++++-------------
1 file changed, 17 insertions(+), 13 deletions(-)
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 80793bad8d..dff17b3178 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -550,24 +550,28 @@ Other incompatible flag pairs:
BEHAVIORAL DIFFERENCES
-----------------------
- * empty commits:
+There are some subtle differences how the backends behave.
- am-based rebase will drop any "empty" commits, whether the
- commit started empty (had no changes relative to its parent to
- start with) or ended empty (all changes were already applied
- upstream in other commits).
+Empty commits
+~~~~~~~~~~~~~
+
+The am backend drops any "empty" commits, regardless of whether the
+commit started empty (had no changes relative to its parent to
+start with) or ended empty (all changes were already applied
+upstream in other commits).
- merge-based rebase does the same.
+The merge backend does the same.
- interactive-based rebase will by default drop commits that
- started empty and halt if it hits a commit that ended up empty.
- The `--keep-empty` option exists for interactive rebases to allow
- it to keep commits that started empty.
+The interactive backend drops commits by default that
+started empty and halts if it hits a commit that ended up empty.
+The `--keep-empty` option exists for the interactive backend to allow
+it to keep commits that started empty.
- * directory rename detection:
+Directory rename detection
+~~~~~~~~~~~~~~~~~~~~~~~~~~
- merge-based and interactive-based rebases work fine with
- directory rename detection. am-based rebases sometimes do not.
+The merge and interactive backends work fine with
+directory rename detection. The am backend sometimes does not.
include::merge-strategies.txt[]
--
2.19.1.1133.g2dd3d172d2
next reply other threads:[~2018-12-03 17:34 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-03 17:34 Johannes Sixt [this message]
2018-12-03 20:42 ` [PATCH] rebase docs: fix incorrect format of the section Behavioral Differences Martin Ågren
2018-12-03 20:50 ` Johannes Sixt
2018-12-04 2:49 ` Junio C Hamano
2018-12-03 20:56 ` Johannes Schindelin
2018-12-04 21:24 ` Elijah Newren
2018-12-04 21:53 ` Johannes Sixt
2018-12-04 23:17 ` Elijah Newren
2018-12-05 3:54 ` Junio C Hamano
2018-12-05 6:20 ` Elijah Newren
2018-12-05 6:57 ` Johannes Sixt
2018-12-05 7:40 ` Junio C Hamano
2018-12-05 15:37 ` Elijah Newren
2018-12-05 21:16 ` Johannes Sixt
2018-12-05 22:46 ` Junio C Hamano
2018-12-07 17:51 ` [PATCH] git-rebase.txt: update note about directory rename detection and am Johannes Sixt
2018-12-07 18:46 ` Elijah Newren
2018-12-09 0:22 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=f26b53e3-e7d1-f0fe-cdd3-dd734beb1628@kdbg.org \
--to=j6t@kdbg.org \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).