Skip to contentSkip to conversation

rapidio: fix kernel-doc warning

PATCH In review Jianjun Kong 2 participants 2 messages Jan 1, 2009 Rapidio

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rapidio: fix kernel-doc warning

rapidio: fix kernel-doc warning

Fix kernel-doc parameter warning and correct the descriptio:
Warning(/media/sda1/Project/linux-2.6//drivers/rapidio/rio-driver.c:88): Excess function parameter 'id' description in 'rio_device_probe'
The parameter 'id' may be deleted.

---
 drivers/rapidio/rio-driver.c |    3 +--
 1 files changed, 1 insertions(+), 2 deletions(-)
drivers/rapidio/rio-driver.c +1 -2
index 956d3e7..cd6f14e 100644
@@ -78,8 +78,7 @@ void rio_dev_put(struct rio_dev *rdev)
 }
 
 /**
- *  rio_device_probe - Tell if a RIO device structure has a matching RIO device id structure
- *  @id: the RIO device id structure to match against
+ *  rio_device_probe - Tell if a RIO device structure has a matching RIO device structure
  *  @dev: the RIO device structure to match against
  *
  * return 0 and set rio_dev->driver when drv claims rio_dev, else error
Signature · 1 line
1.5.6.3
#1 lore raw
Quoted 9 lines · Jianjun Kong

rapidio: fix kernel-doc warning

Fix kernel-doc parameter warning and correct the descriptio:
Warning(/media/sda1/Project/linux-2.6//drivers/rapidio/rio-driver.c:88): Excess function parameter 'id' description in 'rio_device_probe'
The parameter 'id' may be deleted.

Hi and thanks, but this is already fixed in Andrew Morton's mm patch series. You should probably check there for other such patches.

Quoted 18 lines
---
 drivers/rapidio/rio-driver.c |    3 +--
 1 files changed, 1 insertions(+), 2 deletions(-)
drivers/rapidio/rio-driver.c +1 -2
index 956d3e7..cd6f14e 100644
@@ -78,8 +78,7 @@ void rio_dev_put(struct rio_dev *rdev)
 }
 
 /**
- *  rio_device_probe - Tell if a RIO device structure has a matching RIO device id structure
- *  @id: the RIO device id structure to match against
+ *  rio_device_probe - Tell if a RIO device structure has a matching RIO device structure
  *  @dev: the RIO device structure to match against
  *
  * return 0 and set rio_dev->driver when drv claims rio_dev, else error
Signature · 1 line
~Randy