Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d89b1945 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

SubmittingPatches: add more about patch descriptions 



Add more information about patch descriptions.

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Reviewed-by: default avatarChristoph Lameter <cl@linux-foundation.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent cf4ca487

Documentation/SubmittingPatches

+11 −0
Original line number Diff line number Diff line
@@ -98,6 +98,17 @@ system, git, as a "commit log". See #15, below. 
If your description starts to get long, that's a sign that you probably

need to split up your patch.  See #3, next.



When you submit or resubmit a patch or patch series, include the

complete patch description and justification for it.  Don't just

say that this is version N of the patch (series).  Don't expect the

patch merger to refer back to earlier patch versions or referenced

URLs to find the patch description and put that into the patch.

I.e., the patch (series) and its description should be self-contained.

This benefits both the patch merger(s) and reviewers.  Some reviewers

probably didn't even receive earlier versions of the patch.



If the patch fixes a logged bug entry, refer to that bug entry by

number and URL.





3) Separate your changes.