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: Jean Delvare <jdelvare@suse.de> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
This commit is contained in:
parent
8353863a52
commit
f172841573
|
@ -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()
|
||||
--------------------------------------------
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
Loading…
Reference in a new issue