mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc
@ 2026-07-20  3:23 Randy Dunlap
  2026-07-20  3:23 ` [PATCH 2/3] ACPI: bus: Use correct struct member names Randy Dunlap
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Randy Dunlap @ 2026-07-20  3:23 UTC (permalink / raw)
  To: linux-kernel; +Cc: Randy Dunlap, Rafael J. Wysocki, Len Brown, linux-acpi

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'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Len Brown <lenb@kernel.org>
Cc: linux-acpi@vger.kernel.org

 drivers/acpi/fan.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20260717.orig/drivers/acpi/fan.h
+++ linux-next-20260717/drivers/acpi/fan.h
@@ -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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH 2/3] ACPI: bus: Use correct struct member names
  2026-07-20  3:23 [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc Randy Dunlap
@ 2026-07-20  3:23 ` Randy Dunlap
  2026-07-20  3:23 ` [PATCH 3/3] ACPI: pmtmr: Convert to kernel-doc format Randy Dunlap
  2026-07-21 21:06 ` [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc Rafael J. Wysocki (Intel)
  2 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2026-07-20  3:23 UTC (permalink / raw)
  To: linux-kernel; +Cc: Randy Dunlap, Rafael J. Wysocki, Len Brown, linux-acpi

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'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Len Brown <lenb@kernel.org>
Cc: linux-acpi@vger.kernel.org

 include/acpi/acpi_bus.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20260717.orig/include/acpi/acpi_bus.h
+++ linux-next-20260717/include/acpi/acpi_bus.h
@@ -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.
  */

^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH 3/3] ACPI: pmtmr: Convert to kernel-doc format
  2026-07-20  3:23 [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc Randy Dunlap
  2026-07-20  3:23 ` [PATCH 2/3] ACPI: bus: Use correct struct member names Randy Dunlap
@ 2026-07-20  3:23 ` Randy Dunlap
  2026-07-21 21:06 ` [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc Rafael J. Wysocki (Intel)
  2 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2026-07-20  3:23 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Rafael J. Wysocki, Len Brown, linux-acpi,
	Thomas Gleixner, Ingo Molnar, Anna-Maria Behnsen,
	Frederic Weisbecker

Prevent 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

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Ingo Molnar <mingo@elte.hu>
Cc: Anna-Maria Behnsen <anna-maria@linutronix.de>
Cc: Frederic Weisbecker <frederic@kernel.org>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Len Brown <lenb@kernel.org>
Cc: linux-acpi@vger.kernel.org

 include/linux/acpi_pmtmr.h |   10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

--- linux-next-20260717.orig/include/linux/acpi_pmtmr.h
+++ linux-next-20260717/include/linux/acpi_pmtmr.h
@@ -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);
 

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc
  2026-07-20  3:23 [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc Randy Dunlap
  2026-07-20  3:23 ` [PATCH 2/3] ACPI: bus: Use correct struct member names Randy Dunlap
  2026-07-20  3:23 ` [PATCH 3/3] ACPI: pmtmr: Convert to kernel-doc format Randy Dunlap
@ 2026-07-21 21:06 ` Rafael J. Wysocki (Intel)
  2 siblings, 0 replies; 4+ messages in thread
From: Rafael J. Wysocki (Intel) @ 2026-07-21 21:06 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: linux-kernel, Rafael J. Wysocki, Len Brown, linux-acpi

On Mon, Jul 20, 2026 at 5:23 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> 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'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: "Rafael J. Wysocki" <rafael@kernel.org>
> Cc: Len Brown <lenb@kernel.org>
> Cc: linux-acpi@vger.kernel.org
>
>  drivers/acpi/fan.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-next-20260717.orig/drivers/acpi/fan.h
> +++ linux-next-20260717/drivers/acpi/fan.h
> @@ -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!

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2026-07-21 21:06 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-07-20  3:23 [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc Randy Dunlap
2026-07-20  3:23 ` [PATCH 2/3] ACPI: bus: Use correct struct member names Randy Dunlap
2026-07-20  3:23 ` [PATCH 3/3] ACPI: pmtmr: Convert to kernel-doc format Randy Dunlap
2026-07-21 21:06 ` [PATCH 1/3] ACPI: fan: Use correct function parameter name in kernel-doc Rafael J. Wysocki (Intel)

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®