* [PATCH] pci: pwrctl: fix the kerneldoc tag for private fields
@ 2025-06-18 9:11 Bartosz Golaszewski
2025-06-23 18:10 ` Bjorn Helgaas
0 siblings, 1 reply; 2+ messages in thread
From: Bartosz Golaszewski @ 2025-06-18 9:11 UTC (permalink / raw)
To: Bjorn Helgaas; +Cc: linux-pci, linux-kernel, Bartosz Golaszewski, Bjorn Helgaas
From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
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>
---
include/linux/pci-pwrctrl.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/pci-pwrctrl.h b/include/linux/pci-pwrctrl.h
index 7d439b0675e9..4aefc7901cd1 100644
--- a/include/linux/pci-pwrctrl.h
+++ b/include/linux/pci-pwrctrl.h
@@ -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;
--
2.48.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] pci: pwrctl: fix the kerneldoc tag for private fields
2025-06-18 9:11 [PATCH] pci: pwrctl: fix the kerneldoc tag for private fields Bartosz Golaszewski
@ 2025-06-23 18:10 ` Bjorn Helgaas
0 siblings, 0 replies; 2+ messages in thread
From: Bjorn Helgaas @ 2025-06-23 18:10 UTC (permalink / raw)
To: Bartosz Golaszewski
Cc: Bjorn Helgaas, linux-pci, linux-kernel, Bartosz Golaszewski
On Wed, Jun 18, 2025 at 11:11:29AM +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
>
> 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>
Applied to pci/pwrctrl for v6.17, thanks!
> ---
> include/linux/pci-pwrctrl.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/pci-pwrctrl.h b/include/linux/pci-pwrctrl.h
> index 7d439b0675e9..4aefc7901cd1 100644
> --- a/include/linux/pci-pwrctrl.h
> +++ b/include/linux/pci-pwrctrl.h
> @@ -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;
> --
> 2.48.1
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-06-23 18:10 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-06-18 9:11 [PATCH] pci: pwrctl: fix the kerneldoc tag for private fields Bartosz Golaszewski
2025-06-23 18:10 ` Bjorn Helgaas
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).