Re: [PATCH] csum_partial_copy_from_user: clean up inconsistencies in implementations

From: Daniel Borkmann
Date: Mon Feb 17 2014 - 17:31:35 EST


On 02/17/2014 11:20 PM, Mikulas Patocka wrote:
...
The proper way to add commentary is to put it after the "---" delimiter
at the end of the commit message and before the actual patch.

Interesting - I used "---" as a delimiter between the commentary and the
git message in the past and some people said that their patch parser can't
detect "---" and that I should use "From:" line as a delimiter. And now I
see that your patch parser doesn't detect "From:" and needs "---".

It's simple: Documentation/SubmittingPatches +582 says ...

The "---" marker line serves the essential purpose of marking for patch
handling tools where the changelog message ends.

One good use for the additional comments after the "---" marker is for
a diffstat, to show what files have changed, and the number of
inserted and deleted lines per file. A diffstat is especially useful
on bigger patches. Other comments relevant only to the moment or the
maintainer, not suitable for the permanent changelog, should also go
here. A good example of such comments might be "patch changelogs"
which describe what has changed between the v1 and v2 version of the
patch.

So, between "---" and the diffstat you could have put your comment.
That's what the official document says in that regard. ;)
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/