Commit 4e19e72f authored by Guenter Roeck's avatar Guenter Roeck
Browse files

hwmon: submitting-patches: Add note on comment style 



Ask for standard multi-line comments, and ask for consistent
comment style.

Signed-off-by: default avatarGuenter Roeck <linux@roeck-us.net>
parent 9b0cffa6

Documentation/hwmon/submitting-patches.rst

+4 −0
Original line number Diff line number Diff line
@@ -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,