| Message ID | 20211223022856.27822-1-yang.lee@linux.alibaba.com (mailing list archive) |
|---|---|
| State | Mainlined, archived |
| Delegated to: | Rafael Wysocki |
| Headers | show |
| Series | [-next] PCI/ACPI: Fix acpi_pci_osc_control_set() kernel-doc comment | expand |
On Thu, Dec 23, 2021 at 3:29 AM Yang Li <yang.lee@linux.alibaba.com> wrote: > > Add the description of @support and remove @req in > acpi_pci_osc_control_set() kernel-doc comment to remove warnings found > by running scripts/kernel-doc, which is caused by using 'make W=1'. > > drivers/acpi/pci_root.c:337: warning: Excess function parameter 'req' > description in 'acpi_pci_osc_control_set' > drivers/acpi/pci_root.c:337: warning: Function parameter or member > 'support' not described in 'acpi_pci_osc_control_set' > > Reported-by: Abaci Robot <abaci@linux.alibaba.com> > Fixes: 6bc779ee05d4 ("PCI/ACPI: Check for _OSC support in acpi_pci_osc_control_set()") > Signed-off-by: Yang Li <yang.lee@linux.alibaba.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 41a8fef06534..084916604f3c 100644 > --- a/drivers/acpi/pci_root.c > +++ b/drivers/acpi/pci_root.c > @@ -322,7 +322,7 @@ EXPORT_SYMBOL_GPL(acpi_get_pci_dev); > * acpi_pci_osc_control_set - Request control of PCI root _OSC features. > * @handle: ACPI handle of a PCI root bridge (or PCIe Root Complex). > * @mask: Mask of _OSC bits to request control of, place to store control mask. > - * @req: Mask of _OSC bits the control of is essential to the caller. > + * @support: _OSC supported capability. > * > * Run _OSC query for @mask and if that is successful, compare the returned > * mask of control bits with @req. If all of the @req bits are set in the > -- Applied as 5.17 material, thanks!
diff --git a/drivers/acpi/pci_root.c b/drivers/acpi/pci_root.c index 41a8fef06534..084916604f3c 100644 --- a/drivers/acpi/pci_root.c +++ b/drivers/acpi/pci_root.c @@ -322,7 +322,7 @@ EXPORT_SYMBOL_GPL(acpi_get_pci_dev); * acpi_pci_osc_control_set - Request control of PCI root _OSC features. * @handle: ACPI handle of a PCI root bridge (or PCIe Root Complex). * @mask: Mask of _OSC bits to request control of, place to store control mask. - * @req: Mask of _OSC bits the control of is essential to the caller. + * @support: _OSC supported capability. * * Run _OSC query for @mask and if that is successful, compare the returned * mask of control bits with @req. If all of the @req bits are set in the
Add the description of @support and remove @req in acpi_pci_osc_control_set() kernel-doc comment to remove warnings found by running scripts/kernel-doc, which is caused by using 'make W=1'. drivers/acpi/pci_root.c:337: warning: Excess function parameter 'req' description in 'acpi_pci_osc_control_set' drivers/acpi/pci_root.c:337: warning: Function parameter or member 'support' not described in 'acpi_pci_osc_control_set' Reported-by: Abaci Robot <abaci@linux.alibaba.com> Fixes: 6bc779ee05d4 ("PCI/ACPI: Check for _OSC support in acpi_pci_osc_control_set()") Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> --- drivers/acpi/pci_root.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)