Skip to content

Commit d89b194

Browse files
rddunlaptorvalds
authored andcommitted
SubmittingPatches: add more about patch descriptions
Add more information about patch descriptions. Signed-off-by: Randy Dunlap <[email protected]> Reviewed-by: Christoph Lameter <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
1 parent cf4ca48 commit d89b194

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Documentation/SubmittingPatches

+11
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,17 @@ system, git, as a "commit log". See #15, below.
9898
If your description starts to get long, that's a sign that you probably
9999
need to split up your patch. See #3, next.
100100

101+
When you submit or resubmit a patch or patch series, include the
102+
complete patch description and justification for it. Don't just
103+
say that this is version N of the patch (series). Don't expect the
104+
patch merger to refer back to earlier patch versions or referenced
105+
URLs to find the patch description and put that into the patch.
106+
I.e., the patch (series) and its description should be self-contained.
107+
This benefits both the patch merger(s) and reviewers. Some reviewers
108+
probably didn't even receive earlier versions of the patch.
109+
110+
If the patch fixes a logged bug entry, refer to that bug entry by
111+
number and URL.
101112

102113

103114
3) Separate your changes.

0 commit comments

Comments
 (0)