summaryrefslogtreecommitdiff
path: root/lisp/vc/log-edit.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-05-15 11:06:41 +0300
committerEli Zaretskii <eliz@gnu.org>2021-05-15 11:06:41 +0300
commit63d259cc0da6b3a464b1efe76bb17033de98aef9 (patch)
treee6ccd50ab2d57dc0eaf113354ce0af0ed0d46045 /lisp/vc/log-edit.el
parentc18403302df3f07a7f94c3984d65b808fb40e8c1 (diff)
downloademacs-63d259cc0da6b3a464b1efe76bb17033de98aef9.tar.gz
Improve doc string of 'log-edit-generate-changelog-from-diff'
* lisp/vc/log-edit.el (log-edit-generate-changelog-from-diff): Improve the doc string. (Bug#48269)
Diffstat (limited to 'lisp/vc/log-edit.el')
-rw-r--r--lisp/vc/log-edit.el14
1 files changed, 9 insertions, 5 deletions
diff --git a/lisp/vc/log-edit.el b/lisp/vc/log-edit.el
index f115a91a175..4a44787bb03 100644
--- a/lisp/vc/log-edit.el
+++ b/lisp/vc/log-edit.el
@@ -797,11 +797,15 @@ to build the Fixes: header.")
(declare-function diff-add-log-current-defuns "diff-mode" ())
(defun log-edit-generate-changelog-from-diff ()
- "Insert a VC commit log message by looking at the current diff.
-This command is intended to be uses on the \"*vc-log*\" buffer.
-This command will generate a ChangeLog entries listing the
-changed functions. You can then add a description where needed,
-and use \\[fill-paragraph] to join consecutive function names."
+ "Insert a VC commit log message by looking at the current diffs.
+This command is intended to be used in the \"*vc-log*\" buffer.
+This command will generate ChangeLog entries listing the modified
+files and functions changed in those files, based on the diffs
+you are about to commit. You can then add a description for each
+change where needed, and use \\[fill-paragraph] to join consecutive function
+names into a single entry where they all share the same description.
+Should you need to look at the diffs themselves, they can be found
+in the \"*vc-diff*\" buffer produced by this command."
(interactive)
(change-log-insert-entries
(with-current-buffer