diff mbox series

PCI/ACPI: update kernel-doc line comments

Message ID 1600741945-38474-1-git-send-email-tiantao6@hisilicon.com
State Not Applicable
Delegated to: Bjorn Helgaas
Headers show
Series PCI/ACPI: update kernel-doc line comments | expand

Commit Message

Tian Tao Sept. 22, 2020, 2:32 a.m. UTC
Update kernel-doc line comments to fix warnings reported by make W=1.
drivers/acpi/pci_root.c:71: warning: Function parameter or
member 'handle' not described in 'acpi_is_root_bridge'

Signed-off-by: Tian Tao <tiantao6@hisilicon.com>
---
 drivers/acpi/pci_root.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Rafael J. Wysocki Sept. 25, 2020, 4:15 p.m. UTC | #1
On Tue, Sep 22, 2020 at 4:35 AM Tian Tao <tiantao6@hisilicon.com> wrote:
>
> Update kernel-doc line comments to fix warnings reported by make W=1.
> drivers/acpi/pci_root.c:71: warning: Function parameter or
> member 'handle' not described in 'acpi_is_root_bridge'
>
> Signed-off-by: Tian Tao <tiantao6@hisilicon.com>
> ---
>  drivers/acpi/pci_root.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/acpi/pci_root.c b/drivers/acpi/pci_root.c
> index f90e841..8b81280 100644
> --- a/drivers/acpi/pci_root.c
> +++ b/drivers/acpi/pci_root.c
> @@ -62,7 +62,7 @@ static DEFINE_MUTEX(osc_lock);
>
>  /**
>   * acpi_is_root_bridge - determine whether an ACPI CA node is a PCI root bridge
> - * @handle - the ACPI CA node in question.
> + * @handle:  the ACPI CA node in question.
>   *
>   * Note: we could make this API take a struct acpi_device * instead, but
>   * for now, it's more convenient to operate on an acpi_handle.
> --

Applied as 5.10 material with minor edits in the subject and changelog, thanks!
diff mbox series

Patch

diff --git a/drivers/acpi/pci_root.c b/drivers/acpi/pci_root.c
index f90e841..8b81280 100644
--- a/drivers/acpi/pci_root.c
+++ b/drivers/acpi/pci_root.c
@@ -62,7 +62,7 @@  static DEFINE_MUTEX(osc_lock);
 
 /**
  * acpi_is_root_bridge - determine whether an ACPI CA node is a PCI root bridge
- * @handle - the ACPI CA node in question.
+ * @handle:  the ACPI CA node in question.
  *
  * Note: we could make this API take a struct acpi_device * instead, but
  * for now, it's more convenient to operate on an acpi_handle.