Documentation/hwmon/submitting-patches.rst

1 How to Get Your Patch Accepted Into the Hwmon Subsystem
10 ----------
14     - Documentation/process/submit-checklist.rst
15     - Documentation/process/submitting-patches.rst
16     - Documentation/process/coding-style.rst
18 * Please run your patch through 'checkpatch --strict'. There should be no
22 * Please use the standard multi-line comment style. Do not mix C and C++
26 * If your patch generates checkpatch errors, warnings, or check messages,
32 * Please test your patch thoroughly. We are not your test group.
33   Sometimes a patch can not or not completely be tested because of missing
34   hardware. In such cases, you should test-build the code on at least one
35   architecture. If run-time testing was not achieved, it should be written
36   explicitly below the patch header.
38 * If your patch (or the driver) is affected by configuration options such as
43 -------------------------------------------
51   your patch into a cleanup part and the actual addition. This makes it easier
54 * Never mix bug fixes, cleanup, and functional enhancements in a single patch.
58 --------------
60 * Running your patch or driver file(s) through checkpatch does not mean its
82 * Avoid calculations in macros and macro-generated functions. While such macros
95   and supported functions, please see Documentation/driver-api/driver-model/devres.rst.
103   address if a chip is detected on that address. Unnecessary messages will just
108 * Only the following I2C addresses shall be probed: 0x18-0x1f, 0x28-0x2f,
109   0x48-0x4f, 0x58, 0x5c, 0x73 and 0x77. Probing other addresses is strongly
110   discouraged as it is known to cause trouble with other (non-hwmon) I2C
111   chips. If your chip lives at an address which can't be probed then the
136 * Do not create non-standard attributes unless really needed. If you have to use
137   non-standard attributes, or you believe you do, discuss it on the mailing list
139   non-standard attribute(s).
140   Standard attributes are specified in Documentation/hwmon/sysfs-interface.rst.