Re: [PATCH] pci: pwrctl: fix the kerneldoc tag for private fields

[Bjorn Helgaas]

On Wed, Jun 18, 2025 at 11:11:29AM +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>
> 
> 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@xxxxxxxxxx>
> Closes: https://lore.kernel.org/all/20250617233539.GA1177120@bhelgaas/
> Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@xxxxxxxxxx>

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
>