Skip to contentSkip to conversation

pci: fix iov.c kernel-doc warnings

PATCH In review Randy Dunlap 3 participants 4 messages Jan 10, 2013 – Jan 11, 2013 PCI

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 pci: fix iov.c kernel-doc warnings

From: Randy Dunlap <[email protected]>

Fix kernel-doc warning in iov.c:

Warning(drivers/pci/iov.c:752): No description found for parameter 'numvfs'

---
 drivers/pci/iov.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/iov.c +1 -1
@@ -739,7 +739,7 @@ EXPORT_SYMBOL_GPL(pci_num_vf);
 /**
  * pci_sriov_set_totalvfs -- reduce the TotalVFs available
  * @dev: the PCI PF device
- * numvfs: number that should be used for TotalVFs supported
+ * @numvfs: number that should be used for TotalVFs supported
  *
  * Should be called from PF driver's probe routine with
  * device's mutex held.
#1 lore raw
Quoted 23 lines · Randy Dunlap

From: Randy Dunlap<[email protected]>

Fix kernel-doc warning in iov.c:

Warning(drivers/pci/iov.c:752): No description found for parameter 'numvfs'

---
  drivers/pci/iov.c |    2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/iov.c +1 -2
@@ -739,7 +739,7 @@ EXPORT_SYMBOL_GPL(pci_num_vf);
  /**
   * pci_sriov_set_totalvfs -- reduce the TotalVFs available
   * @dev: the PCI PF device
- * numvfs: number that should be used for TotalVFs supported
+ * @numvfs: number that should be used for TotalVFs supported
   *
   * Should be called from PF driver's probe routine with
   * device's mutex held.
--
Quoted 3 lines

To unsubscribe from this list: send the line "unsubscribe linux-pci" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

Thanks for cleanup; /my bad.
Should checkpatch report this issue? if it does, then
my (double-down) bad for missing that correction when I ran it against the patch.

#2 lore raw
Quoted 23 lines · Don Dutile
Quoted 22 lines · Randy Dunlap

From: Randy Dunlap<[email protected]>

Fix kernel-doc warning in iov.c:

Warning(drivers/pci/iov.c:752): No description found for parameter 'numvfs'

---
  drivers/pci/iov.c |    2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/iov.c +1 -1
@@ -739,7 +739,7 @@ EXPORT_SYMBOL_GPL(pci_num_vf);
  /**
   * pci_sriov_set_totalvfs -- reduce the TotalVFs available
   * @dev: the PCI PF device
- * numvfs: number that should be used for TotalVFs supported
+ * @numvfs: number that should be used for TotalVFs supported
   *
   * Should be called from PF driver's probe routine with
   * device's mutex held.
Quoted 8 lines
Quoted 4 lines
Signature · 3 lines
To unsubscribe from this list: send the line "unsubscribe linux-pci" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Thanks for cleanup; /my bad.
Should checkpatch report this issue? if it does, then
my (double-down) bad for missing that correction when I ran it against the patch.

checkpatch doesn't check for missing kernel-doc notation. I run 'make htmldocs' on each kernel to look for kernel-doc errors and warnings.

Signature · 1 line
~Randy
maintainer
#3 lore raw
In reply to Randy Dunlap
Quoted 7 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Fix kernel-doc warning in iov.c:

Warning(drivers/pci/iov.c:752): No description found for parameter 'numvfs'

Thanks, Randy. I applied this to my for-linus branch and it will appear in v3.8 along with the code it applies to.

Bjorn

Quoted 15 lines
---
 drivers/pci/iov.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/iov.c +1 -1
@@ -739,7 +739,7 @@ EXPORT_SYMBOL_GPL(pci_num_vf);
 /**
  * pci_sriov_set_totalvfs -- reduce the TotalVFs available
  * @dev: the PCI PF device
- * numvfs: number that should be used for TotalVFs supported
+ * @numvfs: number that should be used for TotalVFs supported
  *
  * Should be called from PF driver's probe routine with
  * device's mutex held.