[RFO] CVS commit and patch comments

[Thomas Gleixner]

RFO = Request For Obedience :)

Please follow the few simple rules for patch submissions and CVS commit
comments to make the life of patchmonkeys / maintainers easier.


1. Provide a short summary line of the patch in the format:

[MTD] DETAILEDTARGET: short summary
[JFFS2] short summary

DETAILEDTARGET should be one of the MTD subcomponents e.g. NAND, CHIPS,
MAPS, CORE and/or a filename if it simplifies the review/recognition of
patch relevance

2. Empty newline

No futher explanation for this one :)


3. Add a long comment to explain the patch.

Please use understandable wording. We are not experts in witchcraft.
Please omit comments which just resemble the short summary line for
simple patches.


4. Add the appropriate origin information

[From: Realname <realmail>]
[Acked-by: Realname <realmail>]
Signed-off-by: Realname <realmail>

Convenience rule for MTD-CVS writers:
Committing patches to MTD-CVS is an implicit "Signed-off-by: CVS
committer". Therefor MTD-CVS writers may omit their own (the bottom)
Signed-off-by line, if they keep their infradead.org username vs.
Realname/RealMail correlation in scripts/mtdusers.txt up to date. The
Signed-off-by can be created automatically by the CVS->git commit
selection / review script, when this information is available and
correct.


Thanks for your help and understanding.

tglx


PS: Refusing obedience will be tracked down and punished
 - either by tickling to death 
 - or by penalty not less than a keg (25 ltr ~= 6 gal) of beer due for
the next MTD developer meeting scheduled for September/05 at my place.