Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   "Rafael J. Wysocki" <rjw@rjwysocki.net>
To:     Linux ACPI <linux-acpi@vger.kernel.org>
Cc:     LKML <linux-kernel@vger.kernel.org>,
        Linux PM <linux-pm@vger.kernel.org>,
        Mika Westerberg <mika.westerberg@linux.intel.com>,
        Sakari Ailus <sakari.ailus@linux.intel.com>,
        Tomasz Figa <tfiga@chromium.org>
Subject: [PATCH] ACPI: PM: Fix up documentation reference
Date:   Tue, 23 Aug 2022 15:28:02 +0200
Message-ID: <5852809.lOV4Wx5bFT@kreacher>
MIME-Version: 1.0
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

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 <lkp@intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
---
 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)
 {