GNU bug report logs - #57105
Naming of emacs-news-mode vs etc-authors-mode

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 57105 in the body.
You can then email your comments to 57105 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: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: Naming of emacs-news-mode vs etc-authors-mode
Date: Wed, 10 Aug 2022 02:47:05 -0700

Severity: wishlist

It is kind of unfortunate that emacs-news-mode and etc-authors-mode
don't share the same prefix.  Could we change them to use the same one?
Either one or the other would need to be renamed.

The benefit of the "emacs" prefix is that it is more self-explanatory.

The benefit of the "etc" prefix is that it feels more "internal" and
makes it clear that these modes are not really intended for general use.

(It is okay to rename `etc-authors-mode' if we want to as no one will
realistically be relying on it for serious work.)

Thoughts?

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Wed, 10 Aug 2022 14:25:58 +0300

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Wed, 10 Aug 2022 02:47:05 -0700
> 
> Severity: wishlist
> 
> It is kind of unfortunate that emacs-news-mode and etc-authors-mode
> don't share the same prefix.  Could we change them to use the same one?
> Either one or the other would need to be renamed.
> 
> The benefit of the "emacs" prefix is that it is more self-explanatory.
> 
> The benefit of the "etc" prefix is that it feels more "internal" and
> makes it clear that these modes are not really intended for general use.
> 
> (It is okay to rename `etc-authors-mode' if we want to as no one will
> realistically be relying on it for serious work.)

You want to rename etc-authors-mode to emacs-authors-mode?  I'm fine
with that.  But in general, unlike NEWS, AUTHORS have very different
structures in different projects, so we shouldn't pretend that the
mode is applicable outside of the Emacs project.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Wed, 10 Aug 2022 13:53:30 +0200

Stefan Kangas <stefan <at> marxist.se> writes:

> (It is okay to rename `etc-authors-mode' if we want to as no one will
> realistically be relying on it for serious work.)

Yes, I'm fine with renaming it to emacs-etc-authors-mode (or something
like that).

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Wed, 10 Aug 2022 05:40:39 -0700

Eli Zaretskii <eliz <at> gnu.org> writes:

> You want to rename etc-authors-mode to emacs-authors-mode?  I'm fine
> with that.

Thanks.

> But in general, unlike NEWS, AUTHORS have very different
> structures in different projects, so we shouldn't pretend that the
> mode is applicable outside of the Emacs project.

Agreed (but I'd mostly say the same about `emacs-news-mode').

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Wed, 10 Aug 2022 05:40:29 -0700

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Yes, I'm fine with renaming it to emacs-etc-authors-mode (or something
> like that).

That's a good name, thanks.

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

From: Po Lu <luangruo <at> yahoo.com>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Thu, 11 Aug 2022 19:51:45 +0800

Stefan Kangas <stefan <at> marxist.se> writes:

> Lars Ingebrigtsen <larsi <at> gnus.org> writes:
>
>> Yes, I'm fine with renaming it to emacs-etc-authors-mode (or something
>> like that).
>
> That's a good name, thanks.

Then why isn't emacs-news-mode emacs-etc-news-mode?

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

From: Po Lu <luangruo <at> yahoo.com>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Thu, 11 Aug 2022 19:52:27 +0800

Stefan Kangas <stefan <at> marxist.se> writes:

> Agreed (but I'd mostly say the same about `emacs-news-mode').

Emacs NEWS files are very similar to that of most other GNU projects, I
think.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Po Lu <luangruo <at> yahoo.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Thu, 11 Aug 2022 05:28:26 -0700

Po Lu <luangruo <at> yahoo.com> writes:

> Emacs NEWS files are very similar to that of most other GNU projects, I
> think.

I guess you're right, but OTOH GNU projects constitute only a very small
fraction of all free software out there.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Po Lu <luangruo <at> yahoo.com>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Thu, 11 Aug 2022 05:28:36 -0700

Po Lu <luangruo <at> yahoo.com> writes:

> Then why isn't emacs-news-mode emacs-etc-news-mode?

Fair question.  Having slept on this, I think I prefer
`emacs-authors-mode' and `emacs-news-mode', to keep it simple.

To me the only point here is that they should share the same prefix.
People will understand that these modes are related to Emacs files given
the "emacs-" prefix, and if they don't they can always read docstrings.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: Po Lu <luangruo <at> yahoo.com>, 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Thu, 11 Aug 2022 14:38:17 +0200

Stefan Kangas <stefan <at> marxist.se> writes:

> Fair question.  Having slept on this, I think I prefer
> `emacs-authors-mode' and `emacs-news-mode', to keep it simple.

Sounds good to me.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Po Lu <luangruo <at> yahoo.com>, 57105 <at> debbugs.gnu.org
Subject: Re: bug#57105: Naming of emacs-news-mode vs etc-authors-mode
Date: Fri, 12 Aug 2022 09:47:56 -0700

close 57105 29.1
thanks

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Stefan Kangas <stefan <at> marxist.se> writes:
>
>> Fair question.  Having slept on this, I think I prefer
>> `emacs-authors-mode' and `emacs-news-mode', to keep it simple.
>
> Sounds good to me.

Thanks, now done on master (commits 4ab16226e0 and 779d920c9a).

Previous Next

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