[PATCH v2 1/3] git-am.txt: clarify --abort behavior

From: Elijah Newren via GitGitGadget <gitgitgadget@gmail.com>
Date: Sep 10, 2021, 10:31 UTC
Message-ID: <e199df0f3bc5a99e0d77c172316ad119c533f790.1631269876.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.1087.v2.git.git.1631269876.gitgitgadget@gmail.com>

From: Elijah Newren <newren@gmail.com>

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>
---
 Documentation/git-am.txt | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 8714dfcb762..0a4a984dfde 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

-- 
gitgitgadget