Skip to content

Commit

Permalink
hwmon: submitting-patches: Add note on comment style
Browse files Browse the repository at this point in the history
Ask for standard multi-line comments, and ask for consistent
comment style.

Signed-off-by: Guenter Roeck <linux@roeck-us.net>
  • Loading branch information
Guenter Roeck committed Sep 13, 2019
1 parent 9b0cffa commit 4e19e72
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Documentation/hwmon/submitting-patches.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ increase the chances of your change being accepted.
errors, no warnings, and few if any check messages. If there are any
messages, please be prepared to explain.

* Please use the standard multi-line comment style. Do not mix C and C++
style comments in a single driver (with the exception of the SPDX license
identifier).

* If your patch generates checkpatch errors, warnings, or check messages,
please refrain from explanations such as "I prefer that coding style".
Keep in mind that each unnecessary message helps hiding a real problem,
Expand Down

0 comments on commit 4e19e72

Please sign in to comment.