* unique syntax for reporting (submitting bugs)
@ 2021-10-23 7:31 Uwe Brauer
2021-10-23 7:40 ` Po Lu
2021-10-23 8:16 ` Stefan Kangas
0 siblings, 2 replies; 12+ messages in thread
From: Uwe Brauer @ 2021-10-23 7:31 UTC (permalink / raw)
To: emacs-devel; +Cc: auctex-devel, Org Mode List, ding
[-- Attachment #1: Type: text/plain, Size: 1331 bytes --]
Hi
I am sending this email to four mailing list I am using most, and I am
wondering whether this subject has came up in the past.
For years I am wondering about the different syntax for
sending/reporting/submitting bug reports.
I know of
1. org-submit-bug-report but
a. org-agenda-property-bug-report
2. TeX-submit-bug-report, but
a. preview-report-bug
b. reftex-report-bug
1. bbdb-submit-bug-report
2. c-submit-bug-report
3. ffap-submit-bug
4. vm-submit-bug-report
5. gnus-bug
6. report-emacs-bug
So in order not to confuse myself I am using the following alias
(defalias 'emacs-submit-bug-report 'report-emacs-bug)
But I was wondering, couldn't GNU emacs also use this alias in its
default configuration, since it seems a bit more common.
And also the auctex team, which deals with preview-latex and reftex do
the same
(defalias 'preview-submit-bug-report 'preview-report-bug)
(defalias 'reftex-submit-bug-report 'reftex-report-bug)
The org team:
(defalias 'emacs-submit-bug-report 'report-emacs-bug)
(defalias 'org-agenda-property-submit-bug-report 'org-agenda-property-bug-report)
And finally the gnus team
(defalias 'gnus-submit-bug-report 'gnus-bug)
Regards
Uwe Brauer
[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]
^ permalink raw reply [flat|nested] 12+ messages in thread* Re: unique syntax for reporting (submitting bugs)
2021-10-23 7:31 unique syntax for reporting (submitting bugs) Uwe Brauer
@ 2021-10-23 7:40 ` Po Lu
2021-10-23 12:20 ` Uwe Brauer
2021-10-23 8:16 ` Stefan Kangas
1 sibling, 1 reply; 12+ messages in thread
From: Po Lu @ 2021-10-23 7:40 UTC (permalink / raw)
To: Uwe Brauer; +Cc: emacs-devel
Uwe Brauer <oub@mat.ucm.es> writes:
> I am sending this email to four mailing list I am using most, and I am
Please don't cross-post in the future. Generally, you should post to
one list, and only cross-post if instructed to post to some other.
(Other lists intentionally removed.)
> wondering whether this subject has came up in the past. For years I
> am wondering about the different syntax for sending / reporting /
> submitting bug reports.
WDYM by syntax? Different projects will usually have different
preferred forms for bug reports submitted to them, if that's what you
mean.
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: unique syntax for reporting (submitting bugs)
2021-10-23 7:40 ` Po Lu
@ 2021-10-23 12:20 ` Uwe Brauer
2021-10-23 12:40 ` Po Lu
2021-10-23 15:50 ` [External] : " Drew Adams
0 siblings, 2 replies; 12+ messages in thread
From: Uwe Brauer @ 2021-10-23 12:20 UTC (permalink / raw)
To: emacs-devel
[-- Attachment #1: Type: text/plain, Size: 1344 bytes --]
>>> "PL" == Po Lu <luangruo@yahoo.com> writes:
> Uwe Brauer <oub@mat.ucm.es> writes:
>> I am sending this email to four mailing list I am using most, and I am
> Please don't cross-post in the future. Generally, you should post to
> one list, and only cross-post if instructed to post to some other.
Well I know about this rule, and in 99.9% of the cases this is justified.
However recall that
1. Reftex
2. Gnus
3. Org-mode
Are already in the GNU emacs tree. Auctex may follow suit.
On top of that reftex is maintained by the auctex maintainers.
> (Other lists intentionally removed.)
>> wondering whether this subject has came up in the past. For years I
>> am wondering about the different syntax for sending / reporting /
>> submitting bug reports.
> WDYM by syntax? Different projects will usually have different
> preferred forms for bug reports submitted to them, if that's what you
> mean.
There are two issues here.
1. Have a common syntax for sending bug reports, for example
- package-report-bug or
- package-submit-bug-report
2. The other, more complex issue, is that within GNU emacs the
command emacs-report-bug would send an appropriate bug report
based on the mayor mode used when calling the bug-report function
[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]
^ permalink raw reply [flat|nested] 12+ messages in thread* Re: unique syntax for reporting (submitting bugs)
2021-10-23 12:20 ` Uwe Brauer
@ 2021-10-23 12:40 ` Po Lu
2021-10-23 16:04 ` Uwe Brauer
2021-10-23 15:50 ` [External] : " Drew Adams
1 sibling, 1 reply; 12+ messages in thread
From: Po Lu @ 2021-10-23 12:40 UTC (permalink / raw)
To: emacs-devel
Uwe Brauer <oub@mat.ucm.es> writes:
> There are two issues here.
>
> 1. Have a common syntax for sending bug reports, for example
>
> - package-report-bug or
>
> - package-submit-bug-report
What's package-report-bug? I haven't heard of that command before, and
I can't seem to find it anywhere.
^ permalink raw reply [flat|nested] 12+ messages in thread
* RE: [External] : Re: unique syntax for reporting (submitting bugs)
2021-10-23 12:20 ` Uwe Brauer
2021-10-23 12:40 ` Po Lu
@ 2021-10-23 15:50 ` Drew Adams
2021-10-23 16:07 ` Uwe Brauer
1 sibling, 1 reply; 12+ messages in thread
From: Drew Adams @ 2021-10-23 15:50 UTC (permalink / raw)
To: Uwe Brauer, emacs-devel@gnu.org
> There are two issues here.
> 1. Have a common syntax for sending bug reports, for example
> - package-report-bug or
> - package-submit-bug-report
> 2. The other, more complex issue, is that within GNU emacs the
> command emacs-report-bug would send an appropriate bug report
> based on the mayor mode used when calling the bug-report
> function
I don't see the lack of uniqueness as a real problem.
Can you give an example/scenario that points out what
problems might arise from it? I'm not saying there
are none; I just can't see them yet.
What you show there are descriptions of solutions.
It's the problems they're intended to fix that I have
trouble imagining (so far).
___
[FWIW, for my libraries I use "<libname>-send-bug-report".
In this case the command just invokes `browse-url' with
a `mailto:' that constructs a mail skeleton with Subject
line and some instructions and the emacs-version in the
body. (Sending an email isn't much in the way of
"submitting" a report.)]
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [External] : Re: unique syntax for reporting (submitting bugs)
2021-10-23 15:50 ` [External] : " Drew Adams
@ 2021-10-23 16:07 ` Uwe Brauer
2021-10-23 16:43 ` Uwe Brauer
2021-10-23 16:44 ` Drew Adams
0 siblings, 2 replies; 12+ messages in thread
From: Uwe Brauer @ 2021-10-23 16:07 UTC (permalink / raw)
To: emacs-devel
[-- Attachment #1: Type: text/plain, Size: 1309 bytes --]
>>> "DA" == Drew Adams <drew.adams@oracle.com> writes:
>> There are two issues here.
>> 1. Have a common syntax for sending bug reports, for example
>> - package-report-bug or
>> - package-submit-bug-report
>> 2. The other, more complex issue, is that within GNU emacs the
>> command emacs-report-bug would send an appropriate bug report
>> based on the mayor mode used when calling the bug-report
>> function
> I don't see the lack of uniqueness as a real problem.
> Can you give an example/scenario that points out what
> problems might arise from it? I'm not saying there
> are none; I just can't see them yet.
> What you show there are descriptions of solutions.
> It's the problems they're intended to fix that I have
> trouble imagining (so far).
May it is just me. When I want to send a bug report, for some
package/library the first thing I do is running the apropos-command and
searching the word bug, to find out the specific syntax. As I said there
is, at least
- libname-report-bug
- libname-submit-bug-report
- libname-send-bug-report (your example)
So that is confusing I say. If one convention would be chosen, like in
«one ring to rule them all» I think it would simplify things a bit.
At least that is my experience over the years
[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]
^ permalink raw reply [flat|nested] 12+ messages in thread* Re: [External] : Re: unique syntax for reporting (submitting bugs)
2021-10-23 16:07 ` Uwe Brauer
@ 2021-10-23 16:43 ` Uwe Brauer
2021-10-23 16:44 ` Drew Adams
1 sibling, 0 replies; 12+ messages in thread
From: Uwe Brauer @ 2021-10-23 16:43 UTC (permalink / raw)
To: emacs-devel
[-- Attachment #1: Type: text/plain, Size: 773 bytes --]
> May it is just me. When I want to send a bug report, for some
> package/library the first thing I do is running the apropos-command and
> searching the word bug, to find out the specific syntax. As I said there
> is, at least
> - libname-report-bug
> - libname-submit-bug-report
> - libname-send-bug-report (your example)
> So that is confusing I say. If one convention would be chosen, like in
> «one ring to rule them all» I think it would simplify things a bit.
> At least that is my experience over the years
To emphasise this a bit more: suppose there would also be
- libname-deliver-bug-report
- libname-send-by-owl-bug-report
Wouldn't you say, that is a bit too much?
[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]
^ permalink raw reply [flat|nested] 12+ messages in thread* RE: [External] : Re: unique syntax for reporting (submitting bugs)
2021-10-23 16:07 ` Uwe Brauer
2021-10-23 16:43 ` Uwe Brauer
@ 2021-10-23 16:44 ` Drew Adams
1 sibling, 0 replies; 12+ messages in thread
From: Drew Adams @ 2021-10-23 16:44 UTC (permalink / raw)
To: Uwe Brauer, emacs-devel@gnu.org
> So that is confusing I say. If one convention would be chosen, like in
> «one ring to rule them all» I think it would simplify things a bit.
> At least that is my experience over the years
It's OK by me. I don't see it as much of a problem.
But it might not hurt to add some suggestion of a
format to (elisp) `Coding Conventions' for it.
___
(OT - Of course, that node could be made clearer
about how much this or that "rule" is a stylistic
suggestion, versus something intended more strongly.
And then there's the question of whether a given
rule is both strict for submission to Emacs itself
and just a suggestion for other 3rd-party code.)
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: unique syntax for reporting (submitting bugs)
2021-10-23 7:31 unique syntax for reporting (submitting bugs) Uwe Brauer
2021-10-23 7:40 ` Po Lu
@ 2021-10-23 8:16 ` Stefan Kangas
2021-10-23 8:36 ` Eli Zaretskii
1 sibling, 1 reply; 12+ messages in thread
From: Stefan Kangas @ 2021-10-23 8:16 UTC (permalink / raw)
To: Uwe Brauer, emacs-devel
Uwe Brauer <oub@mat.ucm.es> writes:
> So in order not to confuse myself I am using the following alias
>
> (defalias 'emacs-submit-bug-report 'report-emacs-bug)
>
> But I was wondering, couldn't GNU emacs also use this alias in its
> default configuration, since it seems a bit more common.
It's a small mess, indeed.
However, we have in etc/TODO:
** Check for any included packages that define obsolete
bug-reporting commands
Change them to use report-emacs-bug.
*** Related functions (do all of them need changing?):
**** org-submit-bug-report
**** lm-report-bug
**** tramp-bug
**** c-submit-bug-report
I looked into this a little bit two years ago, but then got
side-tracked. Some of these commands should be kept, from the
discussion at the time. I'll make sure to remember to update the TODO
with what I gathered in my notes at that time.
^ permalink raw reply [flat|nested] 12+ messages in thread* Re: unique syntax for reporting (submitting bugs)
2021-10-23 8:16 ` Stefan Kangas
@ 2021-10-23 8:36 ` Eli Zaretskii
2021-10-23 9:48 ` Stefan Kangas
0 siblings, 1 reply; 12+ messages in thread
From: Eli Zaretskii @ 2021-10-23 8:36 UTC (permalink / raw)
To: Stefan Kangas; +Cc: oub, emacs-devel
> From: Stefan Kangas <stefankangas@gmail.com>
> Date: Sat, 23 Oct 2021 01:16:58 -0700
>
> Uwe Brauer <oub@mat.ucm.es> writes:
>
> > So in order not to confuse myself I am using the following alias
> >
> > (defalias 'emacs-submit-bug-report 'report-emacs-bug)
> >
> > But I was wondering, couldn't GNU emacs also use this alias in its
> > default configuration, since it seems a bit more common.
>
> It's a small mess, indeed.
>
> However, we have in etc/TODO:
>
> ** Check for any included packages that define obsolete
> bug-reporting commands
> Change them to use report-emacs-bug.
>
> *** Related functions (do all of them need changing?):
> **** org-submit-bug-report
> **** lm-report-bug
> **** tramp-bug
> **** c-submit-bug-report
>
> I looked into this a little bit two years ago, but then got
> side-tracked. Some of these commands should be kept, from the
> discussion at the time. I'll make sure to remember to update the TODO
> with what I gathered in my notes at that time.
Can't report-emacs-bug intuit what to do by looking at the current
major mode, and perhaps some other variables?
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: unique syntax for reporting (submitting bugs)
2021-10-23 8:36 ` Eli Zaretskii
@ 2021-10-23 9:48 ` Stefan Kangas
0 siblings, 0 replies; 12+ messages in thread
From: Stefan Kangas @ 2021-10-23 9:48 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: oub, emacs-devel
Eli Zaretskii <eliz@gnu.org> writes:
>> I looked into this a little bit two years ago, but then got
>> side-tracked. Some of these commands should be kept, from the
>> discussion at the time. I'll make sure to remember to update the TODO
>> with what I gathered in my notes at that time.
>
> Can't report-emacs-bug intuit what to do by looking at the current
> major mode, and perhaps some other variables?
I think yes, but the cases where they should be kept is from the
previous discussion only where a package maintainer explicitly sees a
specific need for it or otherwise wants to keep it.
^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2021-10-23 16:44 UTC | newest]
Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-10-23 7:31 unique syntax for reporting (submitting bugs) Uwe Brauer
2021-10-23 7:40 ` Po Lu
2021-10-23 12:20 ` Uwe Brauer
2021-10-23 12:40 ` Po Lu
2021-10-23 16:04 ` Uwe Brauer
2021-10-23 15:50 ` [External] : " Drew Adams
2021-10-23 16:07 ` Uwe Brauer
2021-10-23 16:43 ` Uwe Brauer
2021-10-23 16:44 ` Drew Adams
2021-10-23 8:16 ` Stefan Kangas
2021-10-23 8:36 ` Eli Zaretskii
2021-10-23 9:48 ` Stefan Kangas
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).