diff options
authorGuenter Roeck <linux@roeck-us.net>2019-09-13 05:43:06 -0700
committerGuenter Roeck <linux@roeck-us.net>2019-09-13 05:43:06 -0700
commit4e19e72f45d360975c59df8272f98bff59f6b748 (patch)
parenthwmon: submitting-patches: Point to with_info API (diff)
hwmon: submitting-patches: Add note on comment style
Ask for standard multi-line comments, and ask for consistent comment style. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/hwmon/submitting-patches.rst b/Documentation/hwmon/submitting-patches.rst
index 6b73dba32b89..9a218ea996d8 100644
--- a/Documentation/hwmon/submitting-patches.rst
+++ b/Documentation/hwmon/submitting-patches.rst
@@ -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,