diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2025-01-17 07:45:38 +0100 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@bernoul.li> | 2025-01-17 07:45:38 +0100 |
| commit | 8b1438487826e4a4a28521cf749c17cfd278b839 (patch) | |
| tree | 5566ba6cf9494d235da5dad0603efec16eb04aa5 /docs/magit.texi | |
| parent | a8d7460612cd834bd011e93edc6b0d80a313691f (diff) | |
manual: Fix introduction to committing
We do call `git commit' with arguments, just not with `--message'.
Diffstat (limited to 'docs/magit.texi')
| -rw-r--r-- | docs/magit.texi | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/magit.texi b/docs/magit.texi index ffeeeb3..68aaf1d 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 |
