GNU bug report logs - #75143
debbugs info manual name

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 75143 in the body.
You can then email your comments to 75143 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Morgan Smith <Morgan.J.Smith <at> outlook.com>
To: bug-gnu-emacs <at> gnu.org
Subject: debbugs info manual name
Date: Fri, 27 Dec 2024 10:16:48 -0500

Hello!

(This is about the ELPA package debbugs, not Emacs proper)

I wanted to make a quick suggestion on the debbugs info manuals names.
I think we should name the user manual "debbugs" and the programmer
manual "debbugs-programmer-manual" (NOT "debbugs-pm").

Currently the info manual is called: debbugs-ug.info
The programmer info manual is called: debbugs.info

This means people typing "info debbugs" will get the programmer info
manual, not the user info manual.

When I was first starting to use debbugs I skimmed the programmer info
manual accidentally and got quite confused trying to find the
information I wanted.  I ran "info debbugs" and opened the section
"searching bugs" hoping to find the user commands, not elisp ones.

The programmer manual does mention the user manual but as I was skimming
for something specific, not reading it carefully, I missed that.

Thanks,

Morgan

Message #8 received at 75143 <at> debbugs.gnu.org (full text, mbox):

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Morgan Smith <Morgan.J.Smith <at> outlook.com>
Cc: 75143 <at> debbugs.gnu.org
Subject: Re: bug#75143: debbugs info manual name
Date: Fri, 27 Dec 2024 18:10:16 +0100

Morgan Smith <Morgan.J.Smith <at> outlook.com> writes:

> Hello!

Hi Morgan,

> I wanted to make a quick suggestion on the debbugs info manuals names.
> I think we should name the user manual "debbugs" and the programmer
> manual "debbugs-programmer-manual" (NOT "debbugs-pm").
>
> Currently the info manual is called: debbugs-ug.info
> The programmer info manual is called: debbugs.info
>
> This means people typing "info debbugs" will get the programmer info
> manual, not the user info manual.
>
> When I was first starting to use debbugs I skimmed the programmer info
> manual accidentally and got quite confused trying to find the
> information I wanted.  I ran "info debbugs" and opened the section
> "searching bugs" hoping to find the user commands, not elisp ones.
>
> The programmer manual does mention the user manual but as I was skimming
> for something specific, not reading it carefully, I missed that.

Although I understand your reasons, I'm not convinced that this is worth
the trouble. The manuals exist for 13 years (debbugs.texi) and 10 years
(debbugs-ug.texi). It night confuse prople, if we rename them.

Furthermore, there are references to both manuals from outside. Those
references would be broken.

> Thanks,
>
> Morgan

Best regards, Michael.

Message #13 received at 75143 <at> debbugs.gnu.org (full text, mbox):

From: Morgan Smith <morgan.j.smith <at> outlook.com>
To: Michael Albinus <michael.albinus <at> gmx.de>
Cc: 75143 <at> debbugs.gnu.org
Subject: Re: bug#75143: debbugs info manual name
Date: Fri, 27 Dec 2024 12:56:01 -0500

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

> Morgan Smith <Morgan.J.Smith <at> outlook.com> writes:
>
>> Hello!
>
> Hi Morgan,
>
>> I wanted to make a quick suggestion on the debbugs info manuals names.
>> I think we should name the user manual "debbugs" and the programmer
>> manual "debbugs-programmer-manual" (NOT "debbugs-pm").
>>
>> Currently the info manual is called: debbugs-ug.info
>> The programmer info manual is called: debbugs.info
>>
>> This means people typing "info debbugs" will get the programmer info
>> manual, not the user info manual.
>>
>> When I was first starting to use debbugs I skimmed the programmer info
>> manual accidentally and got quite confused trying to find the
>> information I wanted.  I ran "info debbugs" and opened the section
>> "searching bugs" hoping to find the user commands, not elisp ones.
>>
>> The programmer manual does mention the user manual but as I was skimming
>> for something specific, not reading it carefully, I missed that.
>
> Although I understand your reasons, I'm not convinced that this is worth
> the trouble. The manuals exist for 13 years (debbugs.texi) and 10 years
> (debbugs-ug.texi). It night confuse prople, if we rename them.
>
> Furthermore, there are references to both manuals from outside. Those
> references would be broken.
>

These are fair points.  Feel free to close this bug as wontfix if you
determine there is nothing to be done.

When selecting an info manual it still takes me a second to remember
that "Debbugs UG" means user guide.  Maybe this could be fixed by adding
the short description of the manuals to the Info auto-complete menu
(`Info-menu').  I might look into that but that would belong in a
separate bug report.

>> Thanks,
>>
>> Morgan
>
> Best regards, Michael.

Message #16 received at 75143 <at> debbugs.gnu.org (full text, mbox):

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Morgan Smith <morgan.j.smith <at> outlook.com>
Cc: 75143 <at> debbugs.gnu.org
Subject: Re: bug#75143: debbugs info manual name
Date: Sat, 28 Dec 2024 12:32:01 +0100

Morgan Smith <morgan.j.smith <at> outlook.com> writes:

>>> Hello!

Hi Morgan,

> When selecting an info manual it still takes me a second to remember
> that "Debbugs UG" means user guide.  Maybe this could be fixed by adding
> the short description of the manuals to the Info auto-complete menu
> (`Info-menu').  I might look into that but that would belong in a
> separate bug report.

Good idea. You could reuse this bug report for tracking your actions.

>>> Thanks,
>>>
>>> Morgan

Best regards, Michael.

Message #19 received at 75143 <at> debbugs.gnu.org (full text, mbox):

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Morgan Smith <morgan.j.smith <at> outlook.com>
Cc: 75143 <at> debbugs.gnu.org
Subject: Re: bug#75143: debbugs info manual name
Date: Tue, 11 Feb 2025 15:09:20 +0100

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

Hi Morgan,

>> When selecting an info manual it still takes me a second to remember
>> that "Debbugs UG" means user guide.  Maybe this could be fixed by adding
>> the short description of the manuals to the Info auto-complete menu
>> (`Info-menu').  I might look into that but that would belong in a
>> separate bug report.
>
> Good idea. You could reuse this bug report for tracking your actions.

Any progress? I'm ready for a new debbugs release, and I'd like to know
whether there will be any further contribution next time.

If you don't plan to submit anything soon now, could you pls explain
what you have in mind with this proposal? I've tried to check it, but
I've failed to understand what to do.

>>>> Thanks,
>>>>
>>>> Morgan

Best regards, Michael.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.