linux-kernel - Re: [PATCH] PCI: Fix kernel-doc issues

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <86b381d4-17a9-4b68-bd53-aae69ea7ddba@infradead.org>
Date: Thu, 11 Jan 2024 16:00:27 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Bjorn Helgaas <helgaas@...nel.org>, linux-pci@...r.kernel.org
Cc: Sui Jingfeng <suijingfeng@...ngson.cn>,
 Manivannan Sadhasivam <mani@...nel.org>, linux-kernel@...r.kernel.org,
 Bjorn Helgaas <bhelgaas@...gle.com>
Subject: Re: [PATCH] PCI: Fix kernel-doc issues



On 1/11/24 08:28, Bjorn Helgaas wrote:
> From: Bjorn Helgaas <bhelgaas@...gle.com>
> 
> Fix kernel-doc issues reported by
> "find include -name \*pci\* | xargs scripts/kernel-doc -none":
> 
>   include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga'
>   include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc'
>   include/linux/pci-epf.h:83: warning: expecting prototype for struct pci_epf_event_ops. Prototype was for struct pci_epc_event_ops instead
> 
> Signed-off-by: Bjorn Helgaas <bhelgaas@...gle.com>

Acked-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> ---
>  include/linux/pci-epc.h | 2 +-
>  include/linux/pci-epf.h | 2 +-
>  include/linux/pci.h     | 1 +
>  3 files changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/pci-epc.h b/include/linux/pci-epc.h
> index 5cb694031072..bfe41b03b70c 100644
> --- a/include/linux/pci-epc.h
> +++ b/include/linux/pci-epc.h
> @@ -122,7 +122,7 @@ struct pci_epc_mem {
>   * struct pci_epc - represents the PCI EPC device
>   * @dev: PCI EPC device
>   * @pci_epf: list of endpoint functions present in this EPC device
> - * list_lock: Mutex for protecting pci_epf list
> + * @list_lock: Mutex for protecting pci_epf list
>   * @ops: function pointers for performing endpoint operations
>   * @windows: array of address space of the endpoint controller
>   * @mem: first window of the endpoint controller, which corresponds to
> diff --git a/include/linux/pci-epf.h b/include/linux/pci-epf.h
> index 3f44b6aec477..92d0b71d33d7 100644
> --- a/include/linux/pci-epf.h
> +++ b/include/linux/pci-epf.h
> @@ -68,7 +68,7 @@ struct pci_epf_ops {
>  };
>  
>  /**
> - * struct pci_epf_event_ops - Callbacks for capturing the EPC events
> + * struct pci_epc_event_ops - Callbacks for capturing the EPC events
>   * @core_init: Callback for the EPC initialization complete event
>   * @link_up: Callback for the EPC link up event
>   * @link_down: Callback for the EPC link down event
> diff --git a/include/linux/pci.h b/include/linux/pci.h
> index 1a89dc66f89a..eb45087d7e00 100644
> --- a/include/linux/pci.h
> +++ b/include/linux/pci.h
> @@ -715,6 +715,7 @@ static inline bool pci_is_bridge(struct pci_dev *dev)
>  
>  /**
>   * pci_is_vga - check if the PCI device is a VGA device
> + * @pdev: PCI device
>   *
>   * The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define
>   * VGA Base Class and Sub-Classes:

-- 
#Randy