summaryrefslogtreecommitdiff
path: root/Documentation/hwmon
diff options
context:
space:
mode:
authorGuenter Roeck <linux@roeck-us.net>2022-05-11 16:22:51 +0300
committerGuenter Roeck <linux@roeck-us.net>2022-05-22 21:32:31 +0300
commitddaefa209c4ac791c1262e97c9b2d0440c8ef1d5 (patch)
tree31e1c149d69b9dc96c24e76a50da32b790028aab /Documentation/hwmon
parent87743bcf08072b3e1952a0bf5524b2833e667b4c (diff)
downloadlinux-ddaefa209c4ac791c1262e97c9b2d0440c8ef1d5.tar.xz
hwmon: Make chip parameter for with_info API mandatory
Various attempts were made recently to "convert" the old hwmon_device_register() API to devm_hwmon_device_register_with_info() by just changing the function name without actually converting the driver. Prevent this from happening by making the 'chip' parameter of devm_hwmon_device_register_with_info() mandatory. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Diffstat (limited to 'Documentation/hwmon')
-rw-r--r--Documentation/hwmon/hwmon-kernel-api.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/hwmon/hwmon-kernel-api.rst b/Documentation/hwmon/hwmon-kernel-api.rst
index e2975d5caf34..f3276b3a381a 100644
--- a/Documentation/hwmon/hwmon-kernel-api.rst
+++ b/Documentation/hwmon/hwmon-kernel-api.rst
@@ -76,7 +76,7 @@ hwmon_device_register_with_info is the most comprehensive and preferred means
to register a hardware monitoring device. It creates the standard sysfs
attributes in the hardware monitoring core, letting the driver focus on reading
from and writing to the chip instead of having to bother with sysfs attributes.
-The parent device parameter cannot be NULL with non-NULL chip info. Its
+The parent device parameter as well as the chip parameter must not be NULL. Its
parameters are described in more detail below.
devm_hwmon_device_register_with_info is similar to