[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[Maxim Cournoyer]

* doc/contributing.texi (Viewing Bugs within Emacs): Document
debbugs-gnu-default-packages, debbugs-gnu-default-severities.
(Debbugs User Interfaces): Likewise, and mention debbugs-gnu-guix-search.

Suggested-by: Michael Albinus <michael.albinus@gmx.de>
Change-Id: I8e9026bc394b0cf674c8498ca713c332e48c2700
---
 doc/contributing.texi | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 864190b119..c9e89ab25d 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -385,6 +385,7 @@ The Perfect Setup
 save then add @code{(add-hook 'after-save-hook 'copyright-update)} in
 Emacs.
 
+@node Viewing Bugs within Emacs
 @subsection Viewing Bugs within Emacs
 
 Emacs has a nice minor mode called @code{bug-reference}, which, when
@@ -452,6 +453,13 @@ The Perfect Setup
           (group (zero-or-one "cgi/bugreport.cgi?bug="))
           (group-n 3 (one-or-more digit))
           line-end))
+
+;; Reduce the number of prompts with 'M-x debbugs-gnu'.
+(setq debbugs-gnu-default-packages '("guix" "guix-patches"))
+
+;; Show feature requests.
+(setq debbugs-gnu-default-severities
+ '("serious" "important" "normal" "minor" "wishlist"))
 @end lisp
 
 For more information, refer to @ref{Bug Reference,,, emacs, The GNU
@@ -1960,6 +1968,15 @@ Debbugs User Interfaces
 @kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y
 @end example
 
+For a more convenient (shorter) way to access both the bugs and patches
+submissions, you may want to configure the
+@code{debbugs-gnu-default-packages} and
+@code{debbugs-gnu-default-severities} Emacs variables (@pxref{Viewing
+Bugs within Emacs}).
+
+To search for bugs, @samp{@kbd{M-x} debbugs-gnu-guix-search} can be
+used.
+
 @xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on
 this nifty tool!
 

base-commit: e80022ff3adde3184bed6758f604e3aa12942865
-- 
2.41.0

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[Michael Albinus]

Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:

Hi,

> * doc/contributing.texi (Viewing Bugs within Emacs): Document
> debbugs-gnu-default-packages, debbugs-gnu-default-severities.
> (Debbugs User Interfaces): Likewise, and mention debbugs-gnu-guix-search.

FTR, if wanted by the Guix project, we could also extend
debbugs-gnu-guix.el. For example, loading this library could set
debbugs-gnu-default-packages and debbugs-gnu-default-severities as
proposed here.

Best regards, Michael.

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[Simon Tournier]

Hi,

On Thu, 19 Oct 2023 at 09:08, Michael Albinus <michael.albinus@gmx.de> wrote:

> FTR, if wanted by the Guix project, we could also extend
> debbugs-gnu-guix.el. For example, loading this library could set
> debbugs-gnu-default-packages and debbugs-gnu-default-severities as
> proposed here.

You mean debbugs-guix.el, right?

Cheers,
simon

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[Michael Albinus]

Simon Tournier <zimon.toutoune@gmail.com> writes:

> Hi,

Hi Simon,

>> FTR, if wanted by the Guix project, we could also extend
>> debbugs-gnu-guix.el. For example, loading this library could set
>> debbugs-gnu-default-packages and debbugs-gnu-default-severities as
>> proposed here.
>
> You mean debbugs-guix.el, right?

Sure.

> Cheers,
> simon

Best regards, Michael.

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[Maxim Cournoyer]

Hello,

Michael Albinus <michael.albinus@gmx.de> writes:

> Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:
>
> Hi,
>
>> * doc/contributing.texi (Viewing Bugs within Emacs): Document
>> debbugs-gnu-default-packages, debbugs-gnu-default-severities.
>> (Debbugs User Interfaces): Likewise, and mention debbugs-gnu-guix-search.
>
> FTR, if wanted by the Guix project, we could also extend
> debbugs-gnu-guix.el. For example, loading this library could set
> debbugs-gnu-default-packages and debbugs-gnu-default-severities as
> proposed here.

Would that conflict with a user-set debbugs-gnu-default-packages or
debbugs-gnu-default-severities variables?  I'm thinking of a mainly
Emacs developer sometimes also dabbling with Guix, which may want to
have their debbugs-gnu-default-packages set to "emacs" and the likes
even if also using debbugs-guix.el.

If it'd be used as a fall-back to user-specified versions, then that'd
be nice, I think!

-- 
Thanks,
Maxim

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[Michael Albinus]

Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:

> Hello,

Hi Maxim,

>> FTR, if wanted by the Guix project, we could also extend
>> debbugs-gnu-guix.el. For example, loading this library could set
>> debbugs-gnu-default-packages and debbugs-gnu-default-severities as
>> proposed here.
>
> Would that conflict with a user-set debbugs-gnu-default-packages or
> debbugs-gnu-default-severities variables?  I'm thinking of a mainly
> Emacs developer sometimes also dabbling with Guix, which may want to
> have their debbugs-gnu-default-packages set to "emacs" and the likes
> even if also using debbugs-guix.el.
>
> If it'd be used as a fall-back to user-specified versions, then that'd
> be nice, I think!

No, there's only one debbugs-gnu-default-packages or
debbugs-gnu-default-severities. If you change it globally, it's used
everywhere.

If you have situations where you need both Emacs and Guix defaults, you
could add Guix specific commands to debbugs-guix.el. Something like
debbugs-gnu-patches, debbugs-gnu-package, debbugs-gnu,
debbugs-gnu-usertags.

Or you define a hydra (see GNU ELPA package), which sets
debbugs-gnu-default-packages and debbugs-gnu-default-severities to the
preferred values. Then you can call the debbugs-gnu-* commands with that
hydra via the defined shortcuts.

Best regards, Michael.

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[Maxim Cournoyer]

Hi Michael,

Michael Albinus <michael.albinus@gmx.de> writes:

> Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:
>
>> Hello,
>
> Hi Maxim,
>
>>> FTR, if wanted by the Guix project, we could also extend
>>> debbugs-gnu-guix.el. For example, loading this library could set
>>> debbugs-gnu-default-packages and debbugs-gnu-default-severities as
>>> proposed here.
>>
>> Would that conflict with a user-set debbugs-gnu-default-packages or
>> debbugs-gnu-default-severities variables?  I'm thinking of a mainly
>> Emacs developer sometimes also dabbling with Guix, which may want to
>> have their debbugs-gnu-default-packages set to "emacs" and the likes
>> even if also using debbugs-guix.el.
>>
>> If it'd be used as a fall-back to user-specified versions, then that'd
>> be nice, I think!
>
> No, there's only one debbugs-gnu-default-packages or
> debbugs-gnu-default-severities. If you change it globally, it's used
> everywhere.
>
> If you have situations where you need both Emacs and Guix defaults, you
> could add Guix specific commands to debbugs-guix.el. Something like
> debbugs-gnu-patches, debbugs-gnu-package, debbugs-gnu,
> debbugs-gnu-usertags.
>
> Or you define a hydra (see GNU ELPA package), which sets
> debbugs-gnu-default-packages and debbugs-gnu-default-severities to the
> preferred values. Then you can call the debbugs-gnu-* commands with that
> hydra via the defined shortcuts.

Thank you for explaining.  Then I think perhaps it's best to leave these
globals documented in the manual to avoid surprising users.

Thanks for the continued suggestions!

-- 
Maxim

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[pelzflorian (Florian Pelz)]

[-- Attachment #1: Type: text/plain, Size: 750 bytes --]

Hello all.

Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:
> * doc/contributing.texi (Viewing Bugs within Emacs): Document
> debbugs-gnu-default-packages, debbugs-gnu-default-severities.
> (Debbugs User Interfaces): Likewise, and mention debbugs-gnu-guix-search.
> […]
> +
> +;; Reduce the number of prompts with 'M-x debbugs-gnu'.
> +(setq debbugs-gnu-default-packages '("guix" "guix-patches"))
> +
> +;; Show feature requests.
> +(setq debbugs-gnu-default-severities
> + '("serious" "important" "normal" "minor" "wishlist"))

Not being very experienced with Emacs, I tried 'M-x debbugs-gnu' and it
does not prompt for the packages but shows bugs for Emacs by default.

I suggest the attached patch.

Regards,
Florian


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: doc-Use-accurate-wording-in-Emacs-Debbugs-configurat.patch --]
[-- Type: text/x-patch, Size: 1037 bytes --]

From 33ca6d27d97d165255d60d54986998811281aab3 Mon Sep 17 00:00:00 2001
From: Florian Pelz <pelzflorian@pelzflorian.de>
Date: Sat, 11 Nov 2023 13:13:30 +0100
Subject: [PATCH] doc: Use accurate wording in Emacs-Debbugs configuration.

'M-x debbugs-gnu' does not prompt for which bugs to show.
Follow-up to 19fe24c5b978a16cbca3cddbfa3ab9d1ee2c68f2.

* doc/contributing.texi (Viewing Bugs within Emacs): Make comment
more accurate.
---
 doc/contributing.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index f3cc4d7af7..8c7736444e 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -455,7 +455,7 @@ configuration file:
           (group-n 3 (one-or-more digit))
           line-end))
 
-;; Reduce the number of prompts with 'M-x debbugs-gnu'.
+;; Change the default when run as 'M-x debbugs-gnu'.
 (setq debbugs-gnu-default-packages '("guix" "guix-patches"))
 
 ;; Show feature requests.

base-commit: af6105afc67a15a491a0a4fd18a28c9f801a0b94
-- 
2.41.0

[bug#66620] [PATCH] doc: Document extra Emacs-Debbugs configurations.

[pelzflorian (Florian Pelz)]

[-- Attachment #1: Type: text/plain, Size: 308 bytes --]

"pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> writes:
> Not being very experienced with Emacs, I tried 'M-x debbugs-gnu' and it
> does not prompt for the packages but shows bugs for Emacs by default.
>
> I suggest the attached patch.

Attached is v2 with better commit message.

Regards,
Florian

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: v2-doc-Use-accurate-wording-in-Emacs-Debbugs-configu.patch --]
[-- Type: text/x-patch, Size: 998 bytes --]

From: Florian Pelz <pelzflorian@pelzflorian.de>
Date: Sat, 11 Nov 2023 13:13:30 +0100
Subject: [PATCH v2] doc: Use accurate wording in Emacs-Debbugs configuration.

'M-x debbugs-gnu' does not prompt for which bugs to show.
'C-u M-x debbugs-gnu' would.
Follow-up to 19fe24c5b978a16cbca3cddbfa3ab9d1ee2c68f2.

* doc/contributing.texi (Viewing Bugs within Emacs): Make comment
more accurate.
---
 doc/contributing.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 7337f4bd58..5707ff5cde 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -457,7 +457,7 @@ configuration file:
           (group-n 3 (one-or-more digit))
           line-end))
 
-;; Reduce the number of prompts with 'M-x debbugs-gnu'.
+;; Change the default when run as 'M-x debbugs-gnu'.
 (setq debbugs-gnu-default-packages '("guix" "guix-patches"))
 
 ;; Show feature requests.

base-commit: f24b14767d362a84e6469682b4fe303b50f4b589
-- 
2.41.0

bug#66620: [PATCH] doc: Document extra Emacs-Debbugs configurations.

[Maxim Cournoyer]

Hi,

"pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> writes:

> "pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> writes:
>> Not being very experienced with Emacs, I tried 'M-x debbugs-gnu' and it
>> does not prompt for the packages but shows bugs for Emacs by default.
>>
>> I suggest the attached patch.
>
> Attached is v2 with better commit message.

Applied, thanks!

-- 
Thanks,
Maxim