Commit f1728415 authored by Guenter Roeck's avatar Guenter Roeck
Browse files

hwmon: Update documentation to clarify rules for the 'name' attribute 



Clarify that the name attribute must report a valid name, and the rules
for valid names. Also clarify that the name parameter must be provided
for all supported API functions.

Reviewed-by: default avatarJean Delvare <jdelvare@suse.de>
Signed-off-by: default avatarGuenter Roeck <linux@roeck-us.net>
parent 8353863a

Documentation/hwmon/hwmon-kernel-api.txt

+4 −0
Original line number Diff line number Diff line
@@ -89,6 +89,10 @@ the call to devm_hwmon_device_register_with_groups or 
hwmon_device_register_with_info and if the automatic (device managed)

removal would be too late.



All supported hwmon device registration functions only accept valid device

names. Device names including invalid characters (whitespace, '*', or '-')

will be rejected. The 'name' parameter is mandatory.



Using devm_hwmon_device_register_with_info()

--------------------------------------------

Documentation/hwmon/sysfs-interface

+3 −2
Original line number Diff line number Diff line
@@ -86,8 +86,9 @@ given driver if the chip has the feature. 


name		The chip name.

		This should be a short, lowercase string, not containing

		spaces nor dashes, representing the chip name. This is

		the only mandatory attribute.

		whitespace, dashes, or the wildcard character '*'.

		This attribute represents the chip name. It is the only

		mandatory attribute.

		I2C devices get this attribute created automatically.

		RO

CRA Git | Maintained and supported by SUSTech CRA and CCSE