leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

hwmon: submitting-patches: Add note on comment style

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

Signed-off-by: Guenter Roeck <linux@roeck-us.net>
This commit is contained in:
Guenter Roeck
2019-09-13 05:43:06 -07:00
parent 9b0cffa6c4
commit 4e19e72f45
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/hwmon/submitting-patches.rst
View File

@@ -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 errors, no warnings, and few if any check messages. If there are any
messages, please be prepared to explain. 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, * If your patch generates checkpatch errors, warnings, or check messages,
please refrain from explanations such as "I prefer that coding style". please refrain from explanations such as "I prefer that coding style".
Keep in mind that each unnecessary message helps hiding a real problem, Keep in mind that each unnecessary message helps hiding a real problem,