diff mbox series

PCI: Fix kernel-doc issues

Message ID 20240111162850.2177655-1-helgaas@kernel.org (mailing list archive)
State Accepted
Commit 6bd9c2e478a47daa0a6055418f7bb351871dfd85
Headers show
Series PCI: Fix kernel-doc issues | expand

Commit Message

Bjorn Helgaas Jan. 11, 2024, 4:28 p.m. UTC
From: Bjorn Helgaas <bhelgaas@google.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@google.com>
---
 include/linux/pci-epc.h | 2 +-
 include/linux/pci-epf.h | 2 +-
 include/linux/pci.h     | 1 +
 3 files changed, 3 insertions(+), 2 deletions(-)

Comments

Randy Dunlap Jan. 12, 2024, midnight UTC | #1
On 1/11/24 08:28, Bjorn Helgaas wrote:
> From: Bjorn Helgaas <bhelgaas@google.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@google.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.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:
Sui Jingfeng Jan. 12, 2024, 2:35 a.m. UTC | #2
Hi,


On 2024/1/12 00:28, Bjorn Helgaas wrote:
> From: Bjorn Helgaas <bhelgaas@google.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


Thanks a lot for the fix.


> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>


Acked-by: Sui Jingfeng <suijingfeng@loongson.cn>
Manivannan Sadhasivam Jan. 12, 2024, 5:22 a.m. UTC | #3
On Thu, Jan 11, 2024 at 10:28:50AM -0600, Bjorn Helgaas wrote:
> From: Bjorn Helgaas <bhelgaas@google.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@google.com>

Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>

- Mani

> ---
>  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:
> -- 
> 2.34.1
> 
>
Bjorn Helgaas Jan. 12, 2024, 5:09 p.m. UTC | #4
On Thu, Jan 11, 2024 at 10:28:50AM -0600, Bjorn Helgaas wrote:
> From: Bjorn Helgaas <bhelgaas@google.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@google.com>

Applied with Randy's Acked-by and Tested-by for v6.8.  Thanks for the
other replies; I would certainly add them but for the fact that I've
already tagged what I intend to ask Linus to pull for v6.8.

Bjorn
diff mbox series

Patch

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: