2022-08-23 17:19:40

by Rafael J. Wysocki

[permalink] [raw]
Subject: [PATCH] ACPI: PM: Fix up documentation reference

From: Rafael J. Wysocki <[email protected]>

The acpi_dev_state_d0() kerneldoc comment should refer to
non-d0-probe.rst which is there in the tree instead of
low-power-probe.rst which is not. Fix it up.

While at it, adjust the formatting of that comment to save space.

No functional impact.

Fixes: b82a7df4a7f3 ("ACPI: Add a convenience function to tell a device is in D0 state")
Reported-by: kernel test robot <[email protected]>
Signed-off-by: Rafael J. Wysocki <[email protected]>
---
drivers/acpi/device_pm.c | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)

Index: linux-pm/drivers/acpi/device_pm.c
===================================================================
--- linux-pm.orig/drivers/acpi/device_pm.c
+++ linux-pm/drivers/acpi/device_pm.c
@@ -1460,9 +1460,8 @@ EXPORT_SYMBOL_GPL(acpi_storage_d3);
* passed to acpi_device_set_power() and before that function returns, so it is
* not valid to ask for the ACPI power state of the device in that time frame.
*
- * This function is intended to be used in a driver's probe or remove
- * function. See Documentation/firmware-guide/acpi/low-power-probe.rst for
- * more information.
+ * This function is intended to be used in a driver's probe or remove function.
+ * See Documentation/firmware-guide/acpi/non-d0-probe.rst for more information.
*/
bool acpi_dev_state_d0(struct device *dev)
{




2022-08-24 08:45:02

by Mika Westerberg

[permalink] [raw]
Subject: Re: [PATCH] ACPI: PM: Fix up documentation reference

On Tue, Aug 23, 2022 at 03:28:02PM +0200, Rafael J. Wysocki wrote:
> From: Rafael J. Wysocki <[email protected]>
>
> The acpi_dev_state_d0() kerneldoc comment should refer to
> non-d0-probe.rst which is there in the tree instead of
> low-power-probe.rst which is not. Fix it up.
>
> While at it, adjust the formatting of that comment to save space.
>
> No functional impact.
>
> Fixes: b82a7df4a7f3 ("ACPI: Add a convenience function to tell a device is in D0 state")
> Reported-by: kernel test robot <[email protected]>
> Signed-off-by: Rafael J. Wysocki <[email protected]>

Reviewed-by: Mika Westerberg <[email protected]>