With trailing paranthesis(), the docs build will automatically generate cross-links to the documentation. Suggested-by: Jonathan Corbet <corbet@xxxxxxx> Signed-off-by: Guenter Roeck <linux@xxxxxxxxxxxx> --- Jonathan: Did I misunderstand something ? "make htmldocs" did not result in any additional hyperlinks. Documentation/hwmon/hwmon-kernel-api.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/hwmon/hwmon-kernel-api.rst b/Documentation/hwmon/hwmon-kernel-api.rst index 6cacf7daf25c..9edc8521d310 100644 --- a/Documentation/hwmon/hwmon-kernel-api.rst +++ b/Documentation/hwmon/hwmon-kernel-api.rst @@ -44,29 +44,29 @@ register/unregister functions:: char *devm_hwmon_sanitize_name(struct device *dev, const char *name); -hwmon_device_register_with_info registers a hardware monitoring device. +hwmon_device_register_with_info() registers 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 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 -hwmon_device_register_with_info. However, it is device managed, meaning the +devm_hwmon_device_register_with_info() is similar to +hwmon_device_register_with_info(). However, it is device managed, meaning the hwmon device does not have to be removed explicitly by the removal function. All other hardware monitoring device registration functions are deprecated and must not be used in new drivers. -hwmon_device_unregister deregisters a registered hardware monitoring device. +hwmon_device_unregister() deregisters a registered hardware monitoring device. The parameter of this function is the pointer to the registered hardware monitoring device structure. This function must be called from the driver remove function if the hardware monitoring device was registered with -hwmon_device_register_with_info. +hwmon_device_register_with_info(). -devm_hwmon_device_unregister does not normally have to be called. It is only +devm_hwmon_device_unregister() does not normally have to be called. It is only needed for error handling, and only needed if the driver probe fails after -the call to devm_hwmon_device_register_with_info and if the automatic (device +the call to devm_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 @@ -75,14 +75,14 @@ will be rejected. The 'name' parameter is mandatory. If the driver doesn't use a static device name (for example it uses dev_name()), and therefore cannot make sure the name only contains valid -characters, hwmon_sanitize_name can be used. This convenience function +characters, hwmon_sanitize_name() can be used. This convenience function will duplicate the string and replace any invalid characters with an underscore. It will allocate memory for the new string and it is the responsibility of the caller to release the memory when the device is removed. -devm_hwmon_sanitize_name is the resource managed version of -hwmon_sanitize_name; the memory will be freed automatically on device +devm_hwmon_sanitize_name() is the resource managed version of +hwmon_sanitize_name(); the memory will be freed automatically on device removal. Using devm_hwmon_device_register_with_info() @@ -357,7 +357,7 @@ variable. This structure has the following fields:: int index; }; -You can use to_sensor_dev_attr to get the pointer to this structure from the +You can use to_sensor_dev_attr() to get the pointer to this structure from the attribute read or write function. Its parameter is the device to which the attribute is attached. @@ -370,5 +370,5 @@ variable, which is defined as follows:: u8 nr; }; -Use to_sensor_dev_attr_2 to get the pointer to this structure. Its parameter +Use to_sensor_dev_attr_2() to get the pointer to this structure. Its parameter is the device to which the attribute is attached. -- 2.39.2
