diff options
| author | Guenter Roeck <linux@roeck-us.net> | 2019-09-13 08:43:06 -0400 |
|---|---|---|
| committer | Guenter Roeck <linux@roeck-us.net> | 2019-09-13 08:43:06 -0400 |
| commit | 4e19e72f45d360975c59df8272f98bff59f6b748 (patch) | |
| tree | 6407298626146714ca567b0055767860004682f8 | |
| parent | 9b0cffa6c46239b64c60e8c4484a41310708bcec (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>
| -rw-r--r-- | Documentation/hwmon/submitting-patches.rst | 4 |
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. | |||
| 20 | errors, no warnings, and few if any check messages. If there are any | 20 | errors, no warnings, and few if any check messages. If there are any |
| 21 | messages, please be prepared to explain. | 21 | messages, please be prepared to explain. |
| 22 | 22 | ||
| 23 | * Please use the standard multi-line comment style. Do not mix C and C++ | ||
| 24 | style comments in a single driver (with the exception of the SPDX license | ||
| 25 | identifier). | ||
| 26 | |||
| 23 | * If your patch generates checkpatch errors, warnings, or check messages, | 27 | * If your patch generates checkpatch errors, warnings, or check messages, |
| 24 | please refrain from explanations such as "I prefer that coding style". | 28 | please refrain from explanations such as "I prefer that coding style". |
| 25 | Keep in mind that each unnecessary message helps hiding a real problem, | 29 | Keep in mind that each unnecessary message helps hiding a real problem, |