aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-am.txt
diff options
context:
space:
mode:
authorElijah Newren <newren@gmail.com>2021-09-10 10:31:14 +0000
committerJunio C Hamano <gitster@pobox.com>2021-09-10 15:51:14 -0700
commitea7dc012d20feb2b19964c207cd579437d2da26c (patch)
treecb7c6281594decc44079ce07c06c52d0493838e2 /Documentation/git-am.txt
parent225bc32a989d7a22fa6addafd4ce7dcd04675dbf (diff)
downloadgit-ea7dc012d20feb2b19964c207cd579437d2da26c.tar.gz
git-am.txt: clarify --abort behavior
Both Johannes and I assumed (perhaps due to familiarity with rebase) that am --abort would return the user to a clean state. However, since am, unlike rebase, is intended to be used within a dirty working tree, --abort will only clean the files involved in the am operation. Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-am.txt')
-rw-r--r--Documentation/git-am.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 8714dfcb76..0a4a984dfd 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -178,6 +178,8 @@ default. You can use `--no-utf8` to override this.
--abort::
Restore the original branch and abort the patching operation.
+ Revert contents of files involved in the am operation to their
+ pre-am state.
--quit::
Abort the patching operation but keep HEAD and the index