ACPI: PM: Fix up documentation reference
PATCH 1/1 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(-)
drivers/acpi/device_pm.c +2 -3
@@ -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) {
Quoted 6 lines · Rafael J. Wysocki
From: Rafael J. Wysocki <[email protected]>
The
acpi_dev_state_d0()kerneldoc comment should refer tonon-d0-probe.rstwhich is there in the tree instead oflow-power-probe.rstwhich is not. Fix it up.
Quoted 7 lines
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]>