unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Paul Eggert <eggert@cs.ucla.edu>
To: Glenn Morris <rgm@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: master bef1be8: Fixes for "Maintainer:" and related lines
Date: Mon, 20 May 2019 08:39:34 -0700	[thread overview]
Message-ID: <22fdcee1-39b7-fea0-b68c-73de4167a5c5@cs.ucla.edu> (raw)
In-Reply-To: <hu36l9jija.fsf@fencepost.gnu.org>

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

On 5/20/19 7:40 AM, Glenn Morris wrote:
> It is long-standing Emacs convention that if there is
> no Maintainer header, the Author is the maintainer. See elisp node
> "Conventional Headers for Emacs Libraries".

I didn't know that. However, that node doesn't match existing practice 
as it goes on to say, "Some files in Emacs use ‘FSF’ for the 
maintainer.  This means that the original author is no longer 
responsible for the file, and that it is maintained as part of Emacs" 
despite the fact that no files in the Emacs source code use "FSF" for 
the maintainer (either before or after my recent patch).

Also, it appears that many (most?) people didn't know about and didn't 
follow the convention. Not only did the convention not come up in 
discussion until now, it's quite common to see comment pairs like the 
following, which are the first five remaining instances of "Maintainer:" 
lines in Emacs's .el files (sorted by file name):

;; Author: Markus Rost <markus.rost@mathematik.uni-regensburg.de>
;; Maintainer: Markus Rost <rost@math.ohio-state.edu>

;; Author: David Ponce <david@dponce.com>
;; Maintainer: David Ponce <david@dponce.com>

;; Author: David Ponce <david@dponce.com>
;; Maintainer: David Ponce <david@dponce.com>

;; Author: Richard Kim <ryk@dspwiz.com>
;; Maintainer: Richard Kim <ryk@dspwiz.com>

;; Author: Kevin Gallagher <kevin.gal@verizon.net>
;; Maintainer: Kevin Gallagher <kevin.gal@verizon.net>

and this indicates the authors were following the opposite convention 
that a file without a listed maintainer is being maintained collectively.

All in all I think it'd lessen confusion and simplify maintenance if we 
used "Maintainer:" for contacting current maintainers who aren't authors 
and don't normally read bug reports. Something like the attached 
proposed patch, say?


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Adjust-Maintainer-doc.patch --]
[-- Type: text/x-patch; name="0001-Adjust-Maintainer-doc.patch", Size: 1389 bytes --]

From c18d6f7f7c18f5d2ef3a221242146ea2c7acbb5f Mon Sep 17 00:00:00 2001
From: Paul Eggert <eggert@cs.ucla.edu>
Date: Mon, 20 May 2019 08:35:53 -0700
Subject: [PROPOSED] Adjust Maintainer: doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* doc/lispref/tips.texi (Library Headers): Don’t say that
a missing Maintainer: header means the authors are maintainers.
---
 doc/lispref/tips.texi | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index d41fe82572..c46e3a0f6c 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -1011,11 +1011,9 @@ Library Headers
 person(s) who currently maintain(s) the file (respond to bug reports,
 etc.).
 
-If there is no maintainer line, the person(s) in the Author field
-is/are presumed to be the maintainers.  Some files in Emacs use
-@samp{FSF} for the maintainer.  This means that the original author is
-no longer responsible for the file, and that it is maintained as part
-of Emacs.
+If there is no maintainer line, nobody in particular (other than
+perhaps the authors) has volunteered to maintain the file, or an
+ordinary Emacs bug report is a good way to contact the maintainers.
 
 @item Created
 This optional line gives the original creation date of the file, and
-- 
2.21.0


  reply	other threads:[~2019-05-20 15:39 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20190520043434.1198.8439@vcs0.savannah.gnu.org>
     [not found] ` <20190520043437.4F9A82068F@vcs0.savannah.gnu.org>
2019-05-20 14:40   ` master bef1be8: Fixes for "Maintainer:" and related lines Glenn Morris
2019-05-20 15:39     ` Paul Eggert [this message]
2019-05-22 22:19       ` Glenn Morris
2019-05-25 21:34         ` Paul Eggert

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=22fdcee1-39b7-fea0-b68c-73de4167a5c5@cs.ucla.edu \
    --to=eggert@cs.ucla.edu \
    --cc=emacs-devel@gnu.org \
    --cc=rgm@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).