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>
This commit is contained in:
Guenter Roeck 2012-06-16 07:33:52 -07:00
parent d00985f3dd
commit 3fafb0ce92

View File

@ -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 review more difficult. It may also result in code which is more complicated
than necessary. Use inline functions or just regular functions instead. 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 * 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 and messages printed after a successful detection are acceptable, but it
must not print messages such as "Chip XXX not found/supported". must not print messages such as "Chip XXX not found/supported".