pci: pwrctl: fix the kerneldoc tag for private fields
Subsystems (2)
PATCH 1/1 pci: pwrctl: fix the kerneldoc tag for private fields
From: Bartosz Golaszewski <[email protected]>
The correct tag for marking private fields in kerneldoc is "private:", not capitalized "Private:". Fix the pwrctl struct to silence the following warnings:
Warning: include/linux/pci-pwrctrl.h:45 struct member 'nb' not described in 'pci_pwrctrl'
Warning: include/linux/pci-pwrctrl.h:45 struct member 'link' not described in 'pci_pwrctrl'
Warning: include/linux/pci-pwrctrl.h:45 struct member 'work' not described in 'pci_pwrctrl'
--- include/linux/pci-pwrctrl.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/pci-pwrctrl.h +1 -1
@@ -39,7 +39,7 @@ struct device_link;struct pci_pwrctrl {struct device *dev; -/* Private: don't use. */ +/* private: internal use only */ struct notifier_block nb;struct device_link *link;struct work_struct work;
Signature · 1 line
2.48.1
Bjorn Helgaas
AppliedQuoted 6 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
The correct tag for marking private fields in kerneldoc is "private:", not capitalized "Private:". Fix the pwrctl struct to silence the following warnings:
Quoted 8 lines
Warning:
include/linux/pci-pwrctrl.h:45struct member 'nb' not described in 'pci_pwrctrl'
Warning:include/linux/pci-pwrctrl.h:45struct member 'link' not described in 'pci_pwrctrl'
Warning:include/linux/pci-pwrctrl.h:45struct member 'work' not described in 'pci_pwrctrl'Fixes 4565d2652a37 ("PCI/pwrctl: Add PCI power control core code")Reported-by Bjorn Helgaas <[email protected]>Signed-off-by Bartosz Golaszewski <[email protected]>
Applied to pci/pwrctrl for v6.17, thanks!
Quoted 20 lines
--- include/linux/pci-pwrctrl.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/pci-pwrctrl.h +1
-1@@ -39,7 +39,7 @@ struct device_link;struct pci_pwrctrl {struct device *dev; -/* Private: don't use. */ +/* private: internal use only */ struct notifier_block nb;struct device_link *link;struct work_struct work;Signature · 1 line
2.48.1