summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuenter Roeck <linux@roeck-us.net>2012-06-16 07:33:52 -0700
committerGuenter Roeck <linux@roeck-us.net>2012-07-21 21:48:41 -0700
commit3fafb0ce92f13d14ba1c1340ac185e5c78fc7eae (patch)
treeebabc4fc5a7fd37b3bec10f7b7d4b4cd3622ee84
parentd00985f3dd5339eb3068e53f5704ae007ee62f90 (diff)
hwmon: Document the use of devres functions
devres functions are the preferred means to allocate resources in hwmon drivers. Document it. Signed-off-by: Guenter Roeck <linux@roeck-us.net> Acked-by: Jean Delvare <khali@linux-fr.org>
-rw-r--r--Documentation/hwmon/submitting-patches3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/hwmon/submitting-patches b/Documentation/hwmon/submitting-patches
index 86f42e8e9e4..790f774a303 100644
--- a/Documentation/hwmon/submitting-patches
+++ b/Documentation/hwmon/submitting-patches
@@ -70,6 +70,9 @@ increase the chances of your change being accepted.
review more difficult. It may also result in code which is more complicated
than necessary. Use inline functions or just regular functions instead.
+* Use devres functions whenever possible to allocate resources. For rationale
+ and supported functions, please see Documentation/driver-model/devres.txt.
+
* If the driver has a detect function, make sure it is silent. Debug messages
and messages printed after a successful detection are acceptable, but it
must not print messages such as "Chip XXX not found/supported".