summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorGuenter Roeck <linux@roeck-us.net>2022-05-11 16:22:51 +0300
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2022-06-14 19:11:29 +0300
commit1ec0bc72f5dab3ab367ae5230cf6f212d805a225 (patch)
treec33f9ce70e232d769dca455d82d0b319ff3b1021 /Documentation
parenta7a41dd4730303bc9579f11090e88371d72662a2 (diff)
downloadlinux-1ec0bc72f5dab3ab367ae5230cf6f212d805a225.tar.xz
hwmon: Make chip parameter for with_info API mandatory
[ Upstream commit ddaefa209c4ac791c1262e97c9b2d0440c8ef1d5 ] 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> Signed-off-by: Sasha Levin <sashal@kernel.org>
Diffstat (limited to 'Documentation')
-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 c41eb6108103..23f27fe78e37 100644
--- a/Documentation/hwmon/hwmon-kernel-api.rst
+++ b/Documentation/hwmon/hwmon-kernel-api.rst
@@ -72,7 +72,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