aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2025-05-31 13:58:01 +0200
committerJonas Bernoulli <jonas@bernoul.li>2025-05-31 13:58:01 +0200
commit9674c4755a9871568c780beb53bde9ad472db067 (patch)
tree38862bdbeb0db522f84cbc94da8a3337dc7ee9d7 /docs
parent479c4670806dda3589853fa8054c227b89506be1 (diff)
git-rebase-{alter,squish}: New commands
Diffstat (limited to 'docs')
-rw-r--r--docs/magit.org31
-rw-r--r--docs/magit.texi33
2 files changed, 58 insertions, 6 deletions
diff --git a/docs/magit.org b/docs/magit.org
index 4a9d4cd..31ed501 100644
--- a/docs/magit.org
+++ b/docs/magit.org
@@ -6112,12 +6112,37 @@ the following suffix commands.
- Key: s (git-rebase-squash) ::
- Meld commit on current line into previous commit, and edit message.
+ This command folds the commit on the current line into the previous
+ commit, giving the user a change to manually merge the two messages.
+
+- Key: S (git-rebase-squish) ::
+
+ This command folds the commit on the current line into the previous
+ commit, discarding the message of the previous commit but giving the
+ user a change to edit the final message, based on the message of the
+ current commit.
+
+ This action's indicator, shown in the list of commits, is ~fixup -c~
+ (with a lower-case c).
- Key: f (git-rebase-fixup) ::
- Meld commit on current line into previous commit, discarding the
- current commit's message.
+ This command folds the commit on the current line into the previous
+ commit, using only the message of the previous commit as-is and
+ discarding the message of the current commit.
+
+- Key: F (git-rebase-alter) ::
+
+ This command folds the commit on the current into the previous
+ commit, discarding the message of the previous commit and instead
+ using the message of the current commit as-is.
+
+ This is like ~git-rebase-alter~, except that it uses the other
+ message. This is also like ~git-rebase-squish~, except that it lets
+ the user edit the message.
+
+ This action's indicator, shown in the list of commits, is ~fixup -C~
+ (with a upper-case C).
- Key: k (git-rebase-kill-line) ::
diff --git a/docs/magit.texi b/docs/magit.texi
index 3e36f80..ef1e9fd 100644
--- a/docs/magit.texi
+++ b/docs/magit.texi
@@ -7220,13 +7220,40 @@ Stop at the commit on the current line.
@item @kbd{s} (@code{git-rebase-squash})
@kindex s
@findex git-rebase-squash
-Meld commit on current line into previous commit, and edit message.
+This command folds the commit on the current line into the previous
+commit, giving the user a change to manually merge the two messages.
+
+@item @kbd{S} (@code{git-rebase-squish})
+@kindex S
+@findex git-rebase-squish
+This command folds the commit on the current line into the previous
+commit, discarding the message of the previous commit but giving the
+user a change to edit the final message, based on the message of the
+current commit.
+
+This action's indicator, shown in the list of commits, is @code{fixup -c}
+(with a lower-case c).
@item @kbd{f} (@code{git-rebase-fixup})
@kindex f
@findex git-rebase-fixup
-Meld commit on current line into previous commit, discarding the
-current commit's message.
+This command folds the commit on the current line into the previous
+commit, using only the message of the previous commit as-is and
+discarding the message of the current commit.
+
+@item @kbd{F} (@code{git-rebase-alter})
+@kindex F
+@findex git-rebase-alter
+This command folds the commit on the current into the previous
+commit, discarding the message of the previous commit and instead
+using the message of the current commit as-is.
+
+This is like @code{git-rebase-alter}, except that it uses the other
+message. This is also like @code{git-rebase-squish}, except that it lets
+the user edit the message.
+
+This action's indicator, shown in the list of commits, is @code{fixup -C}
+(with a upper-case C).
@item @kbd{k} (@code{git-rebase-kill-line})
@kindex k