[PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[Peter Senna Tschudin]

The shortname for a subsystem, that is primarly used when sending patches over E-mail, is not stored anywhere in the source code. Actually one need to dig git log or mailing list archives. There is no standard, and the Maintainer choose how to short name his/her subsystem. MAINTAINERS file is the right place for storing this information.

U is the second letter of Subsystem.

This will also enable automatic tools like scripts/get_maintainer.pl to provide the correct short name for each filename in the Kernel source tree.

Signed-off-by: Peter Senna Tschudin <peter.senna@gmail.com>
---
 MAINTAINERS | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index 3386238..a1be2a1 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -104,6 +104,11 @@ Descriptions of section entries:
 	      matches patches or files that contain one or more of the words
 	      printk, pr_info or pr_err
 	   One regex pattern per line.  Multiple K: lines acceptable.
+	U: Subsystem short name. Used in the subject of patch sent by email to
+	   identify that subsystem. Short means up to 20 chars. Examples:
+	   U:	media
+	   U:	media/em28xx
+	   U:	SCSI
 
 Note: For the hard of thinking, this list is meant to remain in alphabetical
 order. If you could add yourselves to it in alphabetical order that would be
-- 
1.7.11.4

Re: [PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[Dan Carpenter]

On Tue, Oct 02, 2012 at 01:57:04PM +0200, Peter Senna Tschudin wrote:
> The shortname for a subsystem, that is primarly used when sending patches over E-mail, is not stored anywhere in the source code. Actually one need to dig git log or mailing list archives. There is no standard, and the Maintainer choose how to short name his/her subsystem. MAINTAINERS file is the right place for storing this information.
> 
> U is the second letter of Subsystem.
> 
> This will also enable automatic tools like scripts/get_maintainer.pl to provide the correct short name for each filename in the Kernel source tree.
> 

This is pretty useless without a script to parse it.  Also none of
subsystem names you chose as examples are correct.  Please line wrap
your commit message at 72 characters.

regards,
dan carpenter

Re: [PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[Peter Senna Tschudin]

On Tue, Oct 2, 2012 at 2:14 PM, Dan Carpenter <dan.carpenter@oracle.com> wrote:
> On Tue, Oct 02, 2012 at 01:57:04PM +0200, Peter Senna Tschudin wrote:
>> The shortname for a subsystem, that is primarly used when sending patches over E-mail, is not stored anywhere in the source code. Actually one need to dig git log or mailing list archives. There is no standard, and the Maintainer choose how to short name his/her subsystem. MAINTAINERS file is the right place for storing this information.
>>
>> U is the second letter of Subsystem.
>>
>> This will also enable automatic tools like scripts/get_maintainer.pl to provide the correct short name for each filename in the Kernel source tree.
>>
>
> This is pretty useless without a script to parse it.  Also none of
With or without a script, there is no default way of finding the short
name. Changing scripts/get_maintainer.pl to do it does not seems very
complex.

> subsystem names you chose as examples are correct.  Please line wrap
See? It's not easy to find three examples to put on the text. Can you
please provide three examples?

> your commit message at 72 characters.
Yes. I'll fix it.

Thank you,

Peter

>
> regards,
> dan carpenter
>



-- 
Peter

Re: [PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[Ezequiel Garcia]

On Tue, Oct 2, 2012 at 9:33 AM, Peter Senna Tschudin
<peter.senna@gmail.com> wrote:
> On Tue, Oct 2, 2012 at 2:14 PM, Dan Carpenter <dan.carpenter@oracle.com> wrote:
>> On Tue, Oct 02, 2012 at 01:57:04PM +0200, Peter Senna Tschudin wrote:
>>> The shortname for a subsystem, that is primarly used when sending patches over E-mail, is not stored anywhere in the source code. Actually one need to dig git log or mailing list archives. There is no standard, and the Maintainer choose how to short name his/her subsystem. MAINTAINERS file is the right place for storing this information.
>>>
>>> U is the second letter of Subsystem.
>>>
>>> This will also enable automatic tools like scripts/get_maintainer.pl to provide the correct short name for each filename in the Kernel source tree.
>>>
>>
>> This is pretty useless without a script to parse it.  Also none of
> With or without a script, there is no default way of finding the short
> name. Changing scripts/get_maintainer.pl to do it does not seems very
> complex.
>

Perhaps you should do get_maintainer.pl changes yourself and then
use it to test on some of your patches to see what subject it produces.

Then it's easier to see if the proposal makes sense.
A new rule / standard is something hard to push and we want to have as much
facts as possible to make better decisions.

Thanks,
Ezequiel.

Re: [PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[Peter Senna Tschudin]

On Tue, Oct 2, 2012 at 2:40 PM, Ezequiel Garcia <elezegarcia@gmail.com> wrote:
> On Tue, Oct 2, 2012 at 9:33 AM, Peter Senna Tschudin
> <peter.senna@gmail.com> wrote:
>> On Tue, Oct 2, 2012 at 2:14 PM, Dan Carpenter <dan.carpenter@oracle.com> wrote:
>>> On Tue, Oct 02, 2012 at 01:57:04PM +0200, Peter Senna Tschudin wrote:
>>>> The shortname for a subsystem, that is primarly used when sending patches over E-mail, is not stored anywhere in the source code. Actually one need to dig git log or mailing list archives. There is no standard, and the Maintainer choose how to short name his/her subsystem. MAINTAINERS file is the right place for storing this information.
>>>>
>>>> U is the second letter of Subsystem.
>>>>
>>>> This will also enable automatic tools like scripts/get_maintainer.pl to provide the correct short name for each filename in the Kernel source tree.
>>>>
>>>
>>> This is pretty useless without a script to parse it.  Also none of
>> With or without a script, there is no default way of finding the short
>> name. Changing scripts/get_maintainer.pl to do it does not seems very
>> complex.
>>
>
> Perhaps you should do get_maintainer.pl changes yourself and then
> use it to test on some of your patches to see what subject it produces.
What are your doubts about this method of getting the short name?

>
> Then it's easier to see if the proposal makes sense.
> A new rule / standard is something hard to push and we want to have as much
> facts as possible to make better decisions.
The fact is that currently there is no standard way of getting the
short name for a subsystem. My proposal fixes it allowing to look on
the MAINTAINERS file to see what short name to use.

>
> Thanks,
> Ezequiel.



-- 
Peter

Re: [PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[Ezequiel Garcia]

On Tue, Oct 2, 2012 at 9:53 AM, Peter Senna Tschudin
<peter.senna@gmail.com> wrote:
> On Tue, Oct 2, 2012 at 2:40 PM, Ezequiel Garcia <elezegarcia@gmail.com> wrote:
>> On Tue, Oct 2, 2012 at 9:33 AM, Peter Senna Tschudin
>> <peter.senna@gmail.com> wrote:
>>> On Tue, Oct 2, 2012 at 2:14 PM, Dan Carpenter <dan.carpenter@oracle.com> wrote:
>>>> On Tue, Oct 02, 2012 at 01:57:04PM +0200, Peter Senna Tschudin wrote:
>>>>> The shortname for a subsystem, that is primarly used when sending patches over E-mail, is not stored anywhere in the source code. Actually one need to dig git log or mailing list archives. There is no standard, and the Maintainer choose how to short name his/her subsystem. MAINTAINERS file is the right place for storing this information.
>>>>>
>>>>> U is the second letter of Subsystem.
>>>>>
>>>>> This will also enable automatic tools like scripts/get_maintainer.pl to provide the correct short name for each filename in the Kernel source tree.
>>>>>
>>>>
>>>> This is pretty useless without a script to parse it.  Also none of
>>> With or without a script, there is no default way of finding the short
>>> name. Changing scripts/get_maintainer.pl to do it does not seems very
>>> complex.
>>>
>>
>> Perhaps you should do get_maintainer.pl changes yourself and then
>> use it to test on some of your patches to see what subject it produces.
> What are your doubts about this method of getting the short name?
>

No doubts so far since I haven't seen it in action.
Some script results and more examples could help.

>>
>> Then it's easier to see if the proposal makes sense.
>> A new rule / standard is something hard to push and we want to have as much
>> facts as possible to make better decisions.
> The fact is that currently there is no standard way of getting the
> short name for a subsystem. My proposal fixes it allowing to look on
> the MAINTAINERS file to see what short name to use.
>

There is no standard way of getting short name, and there isn't standard
way of naming a patch either.

Just looking through media list I can spot lots of different subject schemes:
  [media] foo: fix some bug
  media: foo: fix some bug
  foo: fix some bug
  Some random text and fix some bug

Regards,
Ezequiel.

Re: [PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[Peter Senna Tschudin]

On Tue, Oct 2, 2012 at 3:08 PM, Ezequiel Garcia <elezegarcia@gmail.com> wrote:
> On Tue, Oct 2, 2012 at 9:53 AM, Peter Senna Tschudin
> <peter.senna@gmail.com> wrote:
>> On Tue, Oct 2, 2012 at 2:40 PM, Ezequiel Garcia <elezegarcia@gmail.com> wrote:
>>> On Tue, Oct 2, 2012 at 9:33 AM, Peter Senna Tschudin
>>> <peter.senna@gmail.com> wrote:
>>>> On Tue, Oct 2, 2012 at 2:14 PM, Dan Carpenter <dan.carpenter@oracle.com> wrote:
>>>>> On Tue, Oct 02, 2012 at 01:57:04PM +0200, Peter Senna Tschudin wrote:
>>>>>> The shortname for a subsystem, that is primarly used when sending patches over E-mail, is not stored anywhere in the source code. Actually one need to dig git log or mailing list archives. There is no standard, and the Maintainer choose how to short name his/her subsystem. MAINTAINERS file is the right place for storing this information.
>>>>>>
>>>>>> U is the second letter of Subsystem.
>>>>>>
>>>>>> This will also enable automatic tools like scripts/get_maintainer.pl to provide the correct short name for each filename in the Kernel source tree.
>>>>>>
>>>>>
>>>>> This is pretty useless without a script to parse it.  Also none of
>>>> With or without a script, there is no default way of finding the short
>>>> name. Changing scripts/get_maintainer.pl to do it does not seems very
>>>> complex.
>>>>
>>>
>>> Perhaps you should do get_maintainer.pl changes yourself and then
>>> use it to test on some of your patches to see what subject it produces.
>> What are your doubts about this method of getting the short name?
>>
>
> No doubts so far since I haven't seen it in action.
> Some script results and more examples could help.
>
>>>
>>> Then it's easier to see if the proposal makes sense.
>>> A new rule / standard is something hard to push and we want to have as much
>>> facts as possible to make better decisions.
>> The fact is that currently there is no standard way of getting the
>> short name for a subsystem. My proposal fixes it allowing to look on
>> the MAINTAINERS file to see what short name to use.
>>
>
> There is no standard way of getting short name, and there isn't standard
> way of naming a patch either.
>
> Just looking through media list I can spot lots of different subject schemes:
>   [media] foo: fix some bug
>   media: foo: fix some bug
>   foo: fix some bug
>   Some random text and fix some bug

According to:

http://yarchive.net/comp/linux/commit_messages.html

the subsystem short name is also important for whom is not working
directly on that subsystem but may receive the E-mail with the
patch...


>
> Regards,
> Ezequiel.



-- 
Peter

Re: [PATCH RFC] MAINTAINERS: Add section for subsystem shortname

[Joe Perches]

On Tue, 2012-10-02 at 15:13 +0200, Peter Senna Tschudin wrote:
> On Tue, Oct 2, 2012 at 3:08 PM, Ezequiel Garcia <elezegarcia@gmail.com> wrote:
> > Just looking through media list I can spot lots of different subject schemes:
> >   [media] foo: fix some bug
> >   media: foo: fix some bug
> >   foo: fix some bug
> >   Some random text and fix some bug
> 
> According to:
> 
> http://yarchive.net/comp/linux/commit_messages.html
> 
> the subsystem short name is also important for whom is not working
> directly on that subsystem but may receive the E-mail with the
> patch...

Thread from awhile ago:
https://lkml.org/lkml/2010/11/16/245