[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 63d259c: Improve doc string of 'log-edit-generate-changelog-from-
From: |
Eli Zaretskii |
Subject: |
master 63d259c: Improve doc string of 'log-edit-generate-changelog-from-diff' |
Date: |
Sat, 15 May 2021 04:07:54 -0400 (EDT) |
branch: master
commit 63d259cc0da6b3a464b1efe76bb17033de98aef9
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>
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)
---
lisp/vc/log-edit.el | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/lisp/vc/log-edit.el b/lisp/vc/log-edit.el
index f115a91..4a44787 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
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 63d259c: Improve doc string of 'log-edit-generate-changelog-from-diff',
Eli Zaretskii <=