2007-09-21 10:35:30

by Aneesh Kumar K.V

[permalink] [raw]
Subject: Patch format in ext4 patch queue.

Hi all,

I was looking at the patch queue and see patches with different formats.
If we can standardize on what rest of the linux kernel follows it would
be nice.

First line should be
<subsystem_name>: A single line description of the patch.
This appear in the subject line of the mail that results from different
commit list.

eg: ext4: Uninitialized block group support


From: <Author of the patch>
This should be a valid email id. For example stgit checks for the
author to be a valid email id.


<Description of the fix>

Signed-off-by:
Reviewed-by:

What is missing in the patch queue is the First line for most of the patch.

Below is the steps i follow to manage patch queue.

One linux kernel repository:


[[email protected]]$ git checkout -b review v2.6.23-rc6
Switched to a new branch "review"
[[email protected]]$ stg init
[[email protected]]$ stg import --series /home/opensource/patches/ext4-patch-queue/series

Now we should verify patches and make sure they look the way we wanted them in Linus tree by git log

After:
stg pop -> similar to quilt pop
stg push -> similar to quilt push

To edit the commit message
stg edit

To add sign-off or ack

stg edit --sign
stg edit --ack

To change the author name
stg edit --author


Now once we are sure all are fine

stg export -d /home/new-patch-queue-set/

This should get a patch set with quilt series


To find stgit:

http://procode.org/stgit/


-aneesh


2007-09-21 11:24:46

by Aneesh Kumar K.V

[permalink] [raw]
Subject: Re: Patch format in ext4 patch queue.



Aneesh Kumar K.V wrote:
> Hi all,
>
> I was looking at the patch queue and see patches with different formats.
> If we can standardize on what rest of the linux kernel follows it would
> be nice.
>

I found this

http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt

-aneesh

2007-09-21 11:46:41

by Theodore Ts'o

[permalink] [raw]
Subject: Re: Patch format in ext4 patch queue.

On Fri, Sep 21, 2007 at 04:03:26PM +0530, Aneesh Kumar K.V wrote:
>
> I was looking at the patch queue and see patches with different formats.
> If we can standardize on what rest of the linux kernel follows it would
> be nice.
>
> First line should be
> <subsystem_name>: A single line description of the patch.
> This appear in the subject line of the mail that results from different
> commit list....

Yes, please!!! Otherwise I end up having to fix up the patch tree
before I can suck it into git.

- Ted

2007-09-24 21:34:09

by Karel Zak

[permalink] [raw]
Subject: Re: Patch format in ext4 patch queue.

On Fri, Sep 21, 2007 at 04:03:26PM +0530, Aneesh Kumar K.V wrote:
> First line should be
> <subsystem_name>: A single line description of the patch.
> This appear in the subject line of the mail that results from different
> commit list.

BTW, we use this subject format for util-linux-ng and I have a simple
python script that generates nice changelogs (for release notes) from
git log.

IMHO a changelog [1] that is sorted and grouped by <subsystem_name>
is better for end-users that output from git-shortlog.

Karel


[1] see Changelog section:
ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/v2.13/v2.13-ReleaseNotes

--
Karel Zak <[email protected]>