ACPI: fan: Use correct function parameter name in kernel-doc
Subsystems (2)
PATCH 1/3 ACPI: fan: Use correct function parameter name in kernel-doc
Fix kernel-doc warnings by using the correct function parameter name:
Warning: ./drivers/acpi/fan.h:83 function parameter 'speed' not described in 'acpi_fan_speed_valid'
Warning: ./drivers/acpi/fan.h:83 Excess function parameter 'speeed' description in 'acpi_fan_speed_valid'
---
Cc: "Rafael J. Wysocki" <[email protected]>
Cc: Len Brown <[email protected]>
Cc: [email protected]
drivers/acpi/fan.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/acpi/fan.h +1 -1
@@ -69,7 +69,7 @@ struct acpi_fan {/** * acpi_fan_speed_valid - Check if fan speed value is valid -* @speeed: Speed value returned by the ACPI firmware +* @speed: Speed value returned by the ACPI firmware * * Check if the fan speed value returned by the ACPI firmware is valid. This function is * necessary as ACPI firmware implementations can return 0xFFFFFFFF to signal that the
PATCH 2/3 ACPI: bus: Use correct struct member names
Avoid kernel-doc warnings by using the correct struct member names:
Warning: ./include/acpi/acpi_bus.h:429 struct member 'crs_csi2_local' not described in 'acpi_device_software_node_port'
Warning: ./include/acpi/acpi_bus.h:429 Excess struct member 'crs_crs2_local' description in 'acpi_device_software_node_port'
Warning: ./include/acpi/acpi_bus.h:445 struct member 'nodeptrs' not described in 'acpi_device_software_nodes'
Warning: ./include/acpi/acpi_bus.h:445 Excess struct member 'nodeprts' description in 'acpi_device_software_nodes'
---
Cc: "Rafael J. Wysocki" <[email protected]>
Cc: Len Brown <[email protected]>
Cc: [email protected]
include/acpi/acpi_bus.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
include/acpi/acpi_bus.h +2 -2
@@ -410,7 +410,7 @@ enum acpi_device_swnode_ep_props {* @lane_polarities: "lane-polarities" property values. * @link_frequencies: "link_frequencies" property values. * @port_nr: Port number. -* @crs_crs2_local: _CRS CSI2 record present (i.e. this is a transmitter one). +* @crs_csi2_local: _CRS CSI2 record present (i.e. this is a transmitter one). * @port_props: Port properties. * @ep_props: Endpoint properties. * @remote_ep: Reference to the remote endpoint.
@@ -433,7 +433,7 @@ struct acpi_device_software_node_port {* struct acpi_device_software_nodes - Software nodes for an ACPI device * @dev_props: Device properties. * @nodes: Software nodes for root as well as ports and endpoints. -* @nodeprts: Array of software node pointers, for (un)registering them. +* @nodeptrs: Array of software node pointers, for (un)registering them. * @ports: Information related to each port and endpoint within a port. * @num_ports: The number of ports. */
PATCH 3/3 ACPI: pmtmr: Convert to kernel-doc format
In reply to Randy DunlapPrevent kernel-doc warnings by converting 2 functions to kernel-doc format:
Warning: ./include/linux/acpi_pmtmr.h:29 This comment starts with '/**', but isn't a kernel-doc comment.
* Register callback for suspend and resume event
Warning: ./include/linux/acpi_pmtmr.h:37 This comment starts with '/**', but isn't a kernel-doc comment.
* Remove registered callback for suspend and resume event
---
Cc: Thomas Gleixner <[email protected]>
Cc: Ingo Molnar <[email protected]>
Cc: Anna-Maria Behnsen <[email protected]>
Cc: Frederic Weisbecker <[email protected]>
Cc: "Rafael J. Wysocki" <[email protected]>
Cc: Len Brown <[email protected]>
Cc: [email protected]
include/linux/acpi_pmtmr.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
include/linux/acpi_pmtmr.h +6 -4
@@ -27,15 +27,17 @@ static inline u32 acpi_pm_read_early(voi }/** -* Register callback for suspend and resume event +* acpi_pmtmr_register_suspend_resume_callback - Register callback for +* suspend and resume event * -* @cb Callback triggered on suspend and resume -* @data Data passed with the callback +* @cb: Callback triggered on suspend and resume +* @data: Data passed with the callback */ void acpi_pmtmr_register_suspend_resume_callback (void (*cb)(void *data,bool suspend),void *data);/** -* Remove registered callback for suspend and resume event +* acpi_pmtmr_unregister_suspend_resume_callback - Remove registered callback +* for suspend and resume event */ void acpi_pmtmr_unregister_suspend_resume_callback (void );
Quoted 18 lines · Randy Dunlap
Fix kernel-doc warnings by using the correct function parameter name:
Warning:
./drivers/acpi/fan.h:83function parameter 'speed' not described in 'acpi_fan_speed_valid'
Warning:./drivers/acpi/fan.h:83Excess function parameter 'speeed' description in 'acpi_fan_speed_valid'Signed-off-by Randy Dunlap <[email protected]>---
Cc: "Rafael J. Wysocki" <[email protected]>
Cc: Len Brown <[email protected]>
Cc: [email protected]drivers/acpi/fan.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/acpi/fan.h struct acpi_fan { · line 75
Quoted 8 lines
drivers/acpi/fan.h +1
-1@@ -69,7 +69,7 @@ struct acpi_fan {/** * acpi_fan_speed_valid - Check if fan speed value is valid -* @speeed: Speed value returned by the ACPI firmware +* @speed: Speed value returned by the ACPI firmware * * Check if the fan speed value returned by the ACPI firmware is valid. This function is * necessary as ACPI firmware implementations can return 0xFFFFFFFF to signal that the
Applied as 7.3 material along with the other 2 patches in the series, thanks!