korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2025-01-19 20:34:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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: Jean Delvare <jdelvare@suse.de>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
This commit is contained in:
Guenter Roeck 2017-01-24 20:24:36 -08:00
parent 8353863a52
commit f172841573
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/hwmon/hwmon-kernel-api.txt
View File

@ -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) hwmon_device_register_with_info and if the automatic (device managed)
removal would be too late. 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() Using devm_hwmon_device_register_with_info()
-------------------------------------------- --------------------------------------------

5
Documentation/hwmon/sysfs-interface
View File

@ -86,8 +86,9 @@ given driver if the chip has the feature.
name The chip name. name The chip name.
This should be a short, lowercase string, not containing This should be a short, lowercase string, not containing
spaces nor dashes, representing the chip name. This is whitespace, dashes, or the wildcard character '*'.
the only mandatory attribute. This attribute represents the chip name. It is the only
mandatory attribute.
I2C devices get this attribute created automatically. I2C devices get this attribute created automatically.
RO RO