Re: RFC: make MAINTAINERS email addresses easier to copy/paste

Previous thread: [GIT PULL] please pull infiniband.git by Roland Dreier on Tuesday, April 29, 2008 - 1:57 pm. (1 message)

Next thread: [GIT PULL] More i2c updates for 2.6.26 by Jean Delvare on Tuesday, April 29, 2008 - 2:33 pm. (1 message)
From: Bjorn Helgaas
Date: Tuesday, April 29, 2008 - 1:59 pm

I like to use display names for email addresses, e.g.,
"Bjorn Helgaas <bjorn.helgaas@hp.com>" instead of just
"bjorn.helgaas@hp.com".

The current MAINTAINERS file format makes it a nuisance to
copy both the display name and the actual address.  So
I propose that we fold together the current "P:" and "M:"
lines using something similar to the filter below.

If we do this, we should fix a few inconsistencies in the
current file first so the script will work better.  I'll post
a patch to do that as a response to this message.

Bjorn


#!/usr/bin/perl

# Combine name and email address for easier copy and paste.
# For example, this:
#
#	P:	Bjorn Helgaas
#	M:	bjorn.helgaas@hp.com
#
# becomes this:
#
#	P:	Bjorn Helgaas <bjorn.helgaas@hp.com>

while (<>) {
    if (/^P:(\t|\s{2,})(\S.+)/) {
	if (defined($line)) {
	    print $line;
	    undef $line;
	}
	$name = $2;
	$line = $_;
    } elsif (/^M:(\t|\s{2,}).*?(\S+@\S+)/) {
	if (defined($line)) {
	    $mail = $2;
	    $mail =~ s/^<//;
	    $mail =~ s/>$//;
	    print "P:\t$name <$mail>\n";
	    undef $line;
	} else {
	    print;
	}
    } else {
	if (defined($line)) {
	    print $line;
	    undef $line;
	}
	print;
    }
}
--

From: Bjorn Helgaas
Date: Tuesday, April 29, 2008 - 2:00 pm

MAINTAINERS: straighten out Person <-> Mail associations

Sometimes a "P:" line contains several names, followed by an
"M:" line with several email addresses.  And sometimes a single
"P:" line is followed by several "M:" addresses for the same
person.

This patch adds extra "P:" lines to make the associations
unambiguous.

The first hunk is only relevant if we use the preceeding
script to fold the "P:" and "M:" lines together, but the rest
of the patch should be valid in any case.

Signed-off-by: Bjorn Helgaas <bjorn.helgaas@hp.com>

Index: work10/MAINTAINERS
===================================================================
--- work10.orig/MAINTAINERS	2008-04-29 13:31:06.000000000 -0600
+++ work10/MAINTAINERS	2008-04-29 14:45:16.000000000 -0600
@@ -67,8 +67,8 @@
 order. If you could add yourselves to it in alphabetical order that would be
 so much easier [Ed]
 
-P: Person
-M: Mail patches to
+P: Person with email address, e.g., "Andrew Morton <akpm@linux-foundation.org>"
+M: Additional email address for patches
 L: Mailing list that is relevant to this area
 W: Web-page with status/info
 T: SCM tree type and location.  Type is one of: git, hg, quilt.
@@ -218,6 +218,7 @@
 ACPI
 P:	Len Brown
 M:	len.brown@intel.com
+P:	Len Brown
 M:	lenb@kernel.org
 L:	linux-acpi@vger.kernel.org
 W:	http://www.lesswatts.org/projects/acpi/
@@ -1112,11 +1113,14 @@
 L:	alsa-devel@alsa-project.org
 S:	Supported
 
+CIRRUS LOGIC CS4280/CS461x SOUNDDRIVER (2.2 kernel driver)
+P:	Thomas Woller
+M:	twoller@crystal.cirrus.com
+S:	Maintained
+
 CIRRUS LOGIC CS4280/CS461x SOUNDDRIVER
-P:	Cirrus Logic Corporation (kernel 2.2 driver)
-M:	Cirrus Logic Corporation, Thomas Woller <twoller@crystal.cirrus.com>
-P:	Nils Faerber (port to kernel 2.4)
-M:	Nils Faerber <nils@kernelconcepts.de>
+P:	Nils Faerber
+M:	nils@kernelconcepts.de
 S:	Maintained
 
 CODA FILE SYSTEM
@@ -1130,6 +1134,7 @@
 COMPACTPCI HOTPLUG CORE
 P:	Scott Murray
 M:	scottm@somanetworks.com
+P:	Scott Murray
 ...
From: Paul Jackson
Date: Wednesday, April 30, 2008 - 1:03 am

This patch reminded me that I should update the CPUSETS maintainers,
which I will be sending in a separate patch shortly.

However, that in turn highlights one problem with updating several
MAINTAINERS entries at once; it will almost surely collide with
other ongoing updates to the MAINTAINERS file.  On that account,
your proposal might not be worth the extra effort it would take to
get merged ... I'm not sure.

-- 
                  I won't rest till it's the best ...
                  Programmer, Linux Scalability
                  Paul Jackson <pj@sgi.com> 1.940.382.4214
--

From: Bjorn Helgaas
Date: Wednesday, April 30, 2008 - 8:06 am

Yes, that's a problem, and that's why I posted a filter to do the
bulk of the work.  It seems like the easiest way would be for Linus
to run the script and generate a patch at his end.  There are only
a handful of patches in -mm that touch MAINTAINERS, so it shouldn't
generate too many conflicts there.

Bjorn
--

From: Sam Ravnborg
Date: Wednesday, April 30, 2008 - 1:08 am

I would welcome this change as it makes is simpler
to cc relevant people on patches - with their full name.

	Sam
--

From: Christoph Hellwig
Date: Wednesday, April 30, 2008 - 1:49 am

Why do you want to copy the real name?  It's entirely superflous for
mail routing.

--

From: Sam Ravnborg
Date: Wednesday, April 30, 2008 - 2:27 am

I always use the real name in my Cc: tags in my patches.
And I prefer to name people by their name - not their mail address.

So I often use their real name in to: also.
But for me it is easier copy to the Cc: tag that is most important.

	Sam
--

From: Bjorn Helgaas
Date: Wednesday, April 30, 2008 - 8:51 am

Sure, it's superfluous, but I think it's nice to use the name
when I can.  Probably for the same reason you include "Christoph
Hellwig" in your "From:" header :-)
--

From: Christoph Hellwig
Date: Wednesday, April 30, 2008 - 9:04 am

It makes a lot more sense for a from header than for a to header.
If you get mail it'd better have to be for you, while seeing where
it comes from makes at least some sense.  
--

From: Pavel Machek
Date: Friday, May 2, 2008 - 1:44 pm

Yes, please. I wish for this change every single time I have to use
MAINTAINERS.

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
--

From: Rene Herman
Date: Sunday, May 4, 2008 - 6:25 am

ACKACKACKACK.

Rene.
--

Previous thread: [GIT PULL] please pull infiniband.git by Roland Dreier on Tuesday, April 29, 2008 - 1:57 pm. (1 message)

Next thread: [GIT PULL] More i2c updates for 2.6.26 by Jean Delvare on Tuesday, April 29, 2008 - 2:33 pm. (1 message)