Skip to contentSkip to conversation

Patch format in ext4 patch queue.

DISCUSSION Aneesh Kumar K.V 3 participants 4 messages Sep 21, 2007 – Sep 24, 2007

lore
Share & tools
lore

Aneesh Kumar K.V

author
#0 lore raw

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:

[master@linux-review-ext4]$ git checkout -b review v2.6.23-rc6
Switched to a new branch "review"
[review@linux-review-ext4]$ stg init [review@linux-review-ext4]$ 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

#2 lore raw
In reply to Aneesh Kumar K.V
Quoted 9 lines · Aneesh Kumar K.V

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

#3 lore raw
In reply to Aneesh Kumar K.V
Quoted 4 lines · Aneesh Kumar K.V

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
Signature · 1 line
 Karel Zak  <[email protected]>