Commit 2507310c authored by Thien-Thi Nguyen's avatar Thien-Thi Nguyen
Browse files

(log-edit): Doc fix.

parent c8ad8829
2008-01-15 Thien-Thi Nguyen <ttn@gnuvola.org>
* log-edit.el (log-edit): Doc fix.
2008-01-15 Glenn Morris <rgm@gnu.org> 2008-01-15 Glenn Morris <rgm@gnu.org>
* diff-mode.el (diff-end-of-hunk): Revert 2008-01-08 change. * diff-mode.el (diff-end-of-hunk): Revert 2008-01-08 change.
......
...@@ -309,20 +309,20 @@ automatically." ...@@ -309,20 +309,20 @@ automatically."
"Setup a buffer to enter a log message. "Setup a buffer to enter a log message.
\\<log-edit-mode-map>The buffer will be put in `log-edit-mode'. \\<log-edit-mode-map>The buffer will be put in `log-edit-mode'.
If SETUP is non-nil, the buffer is then erased and `log-edit-hook' is run. If SETUP is non-nil, the buffer is then erased and `log-edit-hook' is run.
Mark and point will be set around the entire contents of the Mark and point will be set around the entire contents of the buffer so
buffer so that it is easy to kill the contents of the buffer with \\[kill-region]. that it is easy to kill the contents of the buffer with \\[kill-region].
Once you're done editing the message, pressing \\[log-edit-done] will call Once you're done editing the message, pressing \\[log-edit-done] will call
`log-edit-done' which will end up calling CALLBACK to do the actual commit. `log-edit-done' which will end up calling CALLBACK to do the actual commit.
PARAMS if non-nil is an alist. The keys for the alist can be:
`log-edit-listfun' and `log-edit-diff-function'. The associated PARAMS if non-nil is an alist. Possible keys and associated values:
value for `log-edit-listfun' should be a function with not `log-edit-listfun' -- function taking no arguments that returns the list of
arguments that returns the list of files that are concerned by files that are concerned by the current operation (using relative names);
the current operation (using relative names). The associated `log-edit-diff-function' -- function taking no arguments that
value for `log-edit-diff-function' should be a function with no displays a diff of the files concerned by the current operation.
arguments that displays a diff of the files concerned by the current operation.
If BUFFER is non-nil `log-edit' will jump to that buffer, use it to edit the If BUFFER is non-nil `log-edit' will jump to that buffer, use it to edit the
log message and go back to the current buffer when done. Otherwise, it log message and go back to the current buffer when done. Otherwise, it
uses the current buffer." uses the current buffer."
(let ((parent (current-buffer))) (let ((parent (current-buffer)))
(if buffer (pop-to-buffer buffer)) (if buffer (pop-to-buffer buffer))
(when (and log-edit-setup-invert (not (eq setup 'force))) (when (and log-edit-setup-invert (not (eq setup 'force)))
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment