]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
PCI/pwrctrl: Fix the kerneldoc tag for private fields
authorBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Wed, 18 Jun 2025 09:11:29 +0000 (11:11 +0200)
committerBjorn Helgaas <bhelgaas@google.com>
Mon, 23 Jun 2025 18:09:01 +0000 (13:09 -0500)
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'

Fixes: 4565d2652a37 ("PCI/pwrctl: Add PCI power control core code")
Reported-by: Bjorn Helgaas <helgaas@kernel.org>
Closes: https://lore.kernel.org/all/20250617233539.GA1177120@bhelgaas/
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Link: https://patch.msgid.link/20250618091129.44810-1-brgl@bgdev.pl
include/linux/pci-pwrctrl.h

index 7d439b0675e91e920737287eaf1937f38e47f2ce..4aefc7901cd18b804fbdd6cc0bc8f2050421dc7f 100644 (file)
@@ -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;