branch: elpa/vm
commit 9cbccaa5e559241b384f52750181871f3f26976b
Merge: 7df08867c2 d563c6e814
Author: Mark Diekhans <ma...@ucsc.edu>
Commit: Mark Diekhans <ma...@ucsc.edu>
Merge branch 'main' into 'main'
Fixed regression in vm-submit-bug-report and improve bug submission
documentation a bit
See merge request emacs-vm/vm!42
---
README.md | 12 ++++++++----
lisp/vm.el | 18 ++++++++++++------
2 files changed, 20 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 4dc06aee40..f05ab3c8fb 100644
--- a/README.md
+++ b/README.md
@@ -30,18 +30,22 @@ in _info_ format.
The preferred way to report bugs is to file issues at
https://gitlab.com/emacs-vm/vm/-/issues.
-Alternatively, bugs can be reported report in VM using the VM function
+Alternatively, bugs can be reported report in VM using the VM function.
```
M-x vm-submit-bug-report
```
+This function create a mail message that includes your VM configuration
+information. If you are creating an issue, this information maybe pasted
+into the GitLab issue instead of sending.
+
However, this function currently sends an e-mail to a mailing list,
-which makes the issue hard to track, why the Gitlab issue tracker
-normally is a better option
+which makes the issue hard to track, hence the Gitlab issue tracker
+normally is a better option.
Please include information about how to reproduce the problem. Please
-report any problems or bugs otherwise they cannot be fixed!
+report any problems or bugs, otherwise they cannot be fixed!
If you are not sure that the problem is a bug or that it could be of
general importance to other users, you are welcome to discuss it on
diff --git a/lisp/vm.el b/lisp/vm.el
index 9c2a098eba..910b71808a 100644
--- a/lisp/vm.el
+++ b/lisp/vm.el
@@ -1480,14 +1480,21 @@ summary buffer to select a folder."
(reporter-submit-bug-report
vm-maintainer-address ; address
(concat "VM " (vm-version) ; pkgname
- " commit: " (vm-commit-version))
+ " commit: " (vm-version-commit))
varlist ; varlist
pre-hooks ; pre-hooks
post-hooks ; post-hooks
(concat ; salutation
"INSTRUCTIONS:
-- You are using Emacs default messaging here. *** NOT vm-mail-mode!
+- The preferd way submit a bug report is at:
+
+ https://gitlab.com/emacs-vm/vm/-/issues
+
+ The content of this mail maybe pasted into the issues to understand your
+ configuration.
+
+- You are using Emacs default messaging here. *** NOT vm-mail-mode ***
- Please change the Subject header to a concise bug description.
@@ -1505,10 +1512,9 @@ summary buffer to select a folder."
"
(if (> errors 0)
"
-- The raw definitions for some of the mail configurations are included
- below because there were errors in cleaning them. Please replace any
- sensitive information by xxxx."))
- )
+- The below defintions should be scrubbed of sensitive information.
+ However, please verify this is the case."
+ )))
(goto-char (point-min))
(mail-position-on-field "Subject"))))
