branch: elpa/magit
commit 8b1438487826e4a4a28521cf749c17cfd278b839
Author: Jonas Bernoulli <[email protected]>
Commit: Jonas Bernoulli <[email protected]>
manual: Fix introduction to committing
We do call `git commit' with arguments, just not with `--message'.
---
docs/magit.org | 14 ++++++++------
docs/magit.texi | 14 ++++++++------
2 files changed, 16 insertions(+), 12 deletions(-)
diff --git a/docs/magit.org b/docs/magit.org
index 4972e68960f..f81d934cb95 100644
--- a/docs/magit.org
+++ b/docs/magit.org
@@ -4601,12 +4601,14 @@ appropriate (i.e., when ~git apply~ is used internally).
** Committing
-When the user initiates a commit, Magit calls ~git commit~ without any
-arguments, so Git has to get it from the user. It creates the file
-~.git/COMMIT_EDITMSG~ and then opens that file in an editor. Magit
-arranges for that editor to be the Emacsclient. Once the user
-finishes the editing session, the Emacsclient exits and Git creates the
-commit using the file's content as message.
+When the user initiates a commit, Magit calls ~git commit~ without the
+~--message~ argument, so Git has to get the message from the user. To
+do so, it creates a file such as ~.git/COMMIT_EDITMSG~ and then opens
+that file in the editor specified by ~$EDITOR~ (or ~$GIT_EDITOR~).
+
+Magit arranges for that editor to be the Emacsclient. Once the user
+finishes the editing session, the Emacsclient exits and Git creates
+the commit, using the file's content as the commit message.
*** Initiating a Commit
diff --git a/docs/magit.texi b/docs/magit.texi
index ffeeeb3f13e..68aaf1d751f 100644
--- a/docs/magit.texi
+++ b/docs/magit.texi
@@ -5460,12 +5460,14 @@ appropriate (i.e., when @code{git apply} is used
internally).
@node Committing
@section Committing
-When the user initiates a commit, Magit calls @code{git commit} without any
-arguments, so Git has to get it from the user. It creates the file
-@code{.git/COMMIT_EDITMSG} and then opens that file in an editor. Magit
-arranges for that editor to be the Emacsclient. Once the user
-finishes the editing session, the Emacsclient exits and Git creates the
-commit using the file's content as message.
+When the user initiates a commit, Magit calls @code{git commit} without the
+@code{--message} argument, so Git has to get the message from the user. To
+do so, it creates a file such as @code{.git/COMMIT_EDITMSG} and then opens
+that file in the editor specified by @code{$EDITOR} (or @code{$GIT_EDITOR}).
+
+Magit arranges for that editor to be the Emacsclient. Once the user
+finishes the editing session, the Emacsclient exits and Git creates
+the commit, using the file's content as the commit message.
@anchor{Initiating a Commit}
@subsection Initiating a Commit
