diff options
| author | Guenter Roeck <linux@roeck-us.net> | 2017-01-25 05:24:36 +0100 |
|---|---|---|
| committer | Guenter Roeck <linux@roeck-us.net> | 2017-01-25 15:14:36 +0100 |
| commit | f172841573c41428b422b541bd5f50af0144c330 (patch) | |
| tree | 6c07826e593011f7b8ce1f5dc9c8f26a125077e1 /Documentation/hwmon | |
| parent | hwmon: Make name attribute mandatory for new APIs (diff) | |
| download | linux-f172841573c41428b422b541bd5f50af0144c330.tar.xz linux-f172841573c41428b422b541bd5f50af0144c330.zip | |
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>
Diffstat (limited to 'Documentation/hwmon')
| -rw-r--r-- | Documentation/hwmon/hwmon-kernel-api.txt | 4 | ||||
| -rw-r--r-- | Documentation/hwmon/sysfs-interface | 5 |
2 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/hwmon/hwmon-kernel-api.txt b/Documentation/hwmon/hwmon-kernel-api.txt index 2505ae67e2b6..53a806696c64 100644 --- a/Documentation/hwmon/hwmon-kernel-api.txt +++ b/Documentation/hwmon/hwmon-kernel-api.txt @@ -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() -------------------------------------------- diff --git a/Documentation/hwmon/sysfs-interface b/Documentation/hwmon/sysfs-interface index 2cc95ad46604..fc337c317c67 100644 --- a/Documentation/hwmon/sysfs-interface +++ b/Documentation/hwmon/sysfs-interface @@ -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 |