diff mbox series

[1/5] PCI: Fix kernel-doc formatting

Message ID 20210703151306.1922450-1-kw@linux.com (mailing list archive)
State Accepted
Delegated to: Lorenzo Pieralisi
Headers show
Series [1/5] PCI: Fix kernel-doc formatting | expand

Commit Message

Krzysztof Wilczyński July 3, 2021, 3:13 p.m. UTC
Fix kernel-doc formatting of function pci_dev_set_io_state(), and
resolve build time warnings related to kernel-doc:

  drivers/pci/pci.h:337: warning: Function parameter or member 'dev' not described in 'pci_dev_set_io_state'
  drivers/pci/pci.h:337: warning: Function parameter or member 'new' not described in 'pci_dev_set_io_state'

No change to functionality intended.

Signed-off-by: Krzysztof Wilczyński <kw@linux.com>
---
 drivers/pci/pci.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Bjorn Helgaas July 6, 2021, 4:22 p.m. UTC | #1
On Sat, Jul 03, 2021 at 03:13:02PM +0000, Krzysztof Wilczyński wrote:
> Fix kernel-doc formatting of function pci_dev_set_io_state(), and
> resolve build time warnings related to kernel-doc:
> 
>   drivers/pci/pci.h:337: warning: Function parameter or member 'dev' not described in 'pci_dev_set_io_state'
>   drivers/pci/pci.h:337: warning: Function parameter or member 'new' not described in 'pci_dev_set_io_state'
> 
> No change to functionality intended.
> 
> Signed-off-by: Krzysztof Wilczyński <kw@linux.com>

I squashed these together and applied to pci/kernel-doc for v5.14,
thanks!

> ---
>  drivers/pci/pci.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/pci/pci.h b/drivers/pci/pci.h
> index 37c913bbc6e1..c1ac65cc4572 100644
> --- a/drivers/pci/pci.h
> +++ b/drivers/pci/pci.h
> @@ -324,8 +324,8 @@ struct pci_sriov {
>  /**
>   * pci_dev_set_io_state - Set the new error state if possible.
>   *
> - * @dev - pci device to set new error_state
> - * @new - the state we want dev to be in
> + * @dev: pci device to set new error_state
> + * @new: the state we want dev to be in
>   *
>   * Must be called with device_lock held.
>   *
> -- 
> 2.32.0
>
diff mbox series

Patch

diff --git a/drivers/pci/pci.h b/drivers/pci/pci.h
index 37c913bbc6e1..c1ac65cc4572 100644
--- a/drivers/pci/pci.h
+++ b/drivers/pci/pci.h
@@ -324,8 +324,8 @@  struct pci_sriov {
 /**
  * pci_dev_set_io_state - Set the new error state if possible.
  *
- * @dev - pci device to set new error_state
- * @new - the state we want dev to be in
+ * @dev: pci device to set new error_state
+ * @new: the state we want dev to be in
  *
  * Must be called with device_lock held.
  *