[PATCH 2/4] Documentation: define 'MERGE_AUTOSTASH'

From: Philippe Blain via GitGitGadget <gitgitgadget@gmail.com>
Date: Jul 23, 2021, 12:14 UTC
Message-ID: <5d3d95c9cb978ee02d9e39c5eb70b49ecdbd218f.1627042470.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.1002.git.1627042470.gitgitgadget@gmail.com>

From: Philippe Blain <levraiphilippeblain@gmail.com>

The documentation for 'git merge --abort' and 'git merge --quit' both mention the special ref 'MERGE_AUTOSTASH', but this ref is not formally defined anywhere. Mention it in the description of the '--autostash' option for 'git merge'.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
---
 Documentation/merge-options.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index eb0aabd396f..52565014c15 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -154,7 +154,8 @@ endif::git-pull[]
 --autostash::
 --no-autostash::
 	Automatically create a temporary stash entry before the operation
-	begins, and apply it after the operation ends.  This means
+	begins, record it in the special ref `MERGE_AUTOSTASH`
+	and apply it after the operation ends.  This means
 	that you can run the operation on a dirty worktree.  However, use
 	with care: the final stash application after a successful
 	merge might result in non-trivial conflicts.

-- 
gitgitgadget