summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2008-01-15 15:03:36 +0000
committerThien-Thi Nguyen <ttn@gnuvola.org>2008-01-15 15:03:36 +0000
commit2507310c84e569a0dcb981d497b8a067dfaffccd (patch)
tree403335f78d1c8a4eda6b877bc773d76ff645eb11
parentc8ad88298aa28a2dcef74d124937cff3e98f140b (diff)
downloademacs-2507310c84e569a0dcb981d497b8a067dfaffccd.tar.gz
emacs-2507310c84e569a0dcb981d497b8a067dfaffccd.tar.bz2
emacs-2507310c84e569a0dcb981d497b8a067dfaffccd.zip
(log-edit): Doc fix.
-rw-r--r--lisp/ChangeLog4
-rw-r--r--lisp/log-edit.el22
2 files changed, 15 insertions, 11 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 2c215d57da0..a8c91301933 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2008-01-15 Thien-Thi Nguyen <ttn@gnuvola.org>
+
+ * log-edit.el (log-edit): Doc fix.
+
2008-01-15 Glenn Morris <rgm@gnu.org>
* diff-mode.el (diff-end-of-hunk): Revert 2008-01-08 change.
diff --git a/lisp/log-edit.el b/lisp/log-edit.el
index b92de701b03..5447cda9f1c 100644
--- a/lisp/log-edit.el
+++ b/lisp/log-edit.el
@@ -309,20 +309,20 @@ automatically."
"Setup a buffer to enter a log message.
\\<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.
-Mark and point will be set around the entire contents of the
-buffer so that it is easy to kill the contents of the buffer with \\[kill-region].
+Mark and point will be set around the entire contents of the buffer so
+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
`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
-value for `log-edit-listfun' should be a function with not
-arguments that returns the list of files that are concerned by
-the current operation (using relative names). The associated
-value for `log-edit-diff-function' should be a function with no
-arguments that displays a diff of the files concerned by the current operation.
+
+PARAMS if non-nil is an alist. Possible keys and associated values:
+ `log-edit-listfun' -- function taking no arguments that returns the list of
+ files that are concerned by the current operation (using relative names);
+ `log-edit-diff-function' -- function taking no 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
- log message and go back to the current buffer when done. Otherwise, it
- uses the current buffer."
+log message and go back to the current buffer when done. Otherwise, it
+uses the current buffer."
(let ((parent (current-buffer)))
(if buffer (pop-to-buffer buffer))
(when (and log-edit-setup-invert (not (eq setup 'force)))