diff options
author | Greg Kroah-Hartman <gregkh@suse.de> | 2005-11-14 21:01:17 -0800 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@suse.de> | 2005-11-14 21:01:17 -0800 |
commit | fd4a4424fd06f42c2ce96a3295f11f00dfad559e (patch) | |
tree | 2caed0669eb27482cb8f21926beab7af1c44d587 /HOWTO | |
parent | 6496beb3db5f74c466d3188de862db711ef94e23 (diff) | |
download | patches-fd4a4424fd06f42c2ce96a3295f11f00dfad559e.tar.gz |
added section about better documenting of changes as per akpm's request
Diffstat (limited to 'HOWTO')
-rw-r--r-- | HOWTO | 22 |
1 files changed, 20 insertions, 2 deletions
@@ -381,6 +381,23 @@ the Linux community know why they should add this change. New features must be justified as being needed and useful. +Document your change +-------------------- + +When sending in your patches, pay special attention to what you say in +the text in your email. This information will become the ChangeLog +information for the patch, and will be preserved for everyone to see for +all time. It should describe the patch completely, containing: + - why the change is necessary + - the overall design approach in the patch + - implementation details + - testing results + +For more details on what the this should all look like, please see the +ChangeLog section of the document: + "The Perfect Patch" + http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt + All of these things are sometimes very hard to do. It can take years to @@ -395,8 +412,9 @@ start exactly where you are now. ---------- Thanks to Randy Dunlap and Gerrit Huizenga for the list of things you should and should not say. Also thanks to Pat Mochel, Hanna Linder, -Randy Dunlap, Kay Sievers, Vojtech Pavlik, Jan Kara, Josh Boyer, and -Kees Cook for their review and comments on early drafts of this +Randy Dunlap, Kay Sievers, Vojtech Pavlik, Jan Kara, Josh Boyer, Kees +Cook, and Andrew Morton for their review and comments on early drafts of +this document. |