Skip to contentSkip to conversation

rapidio: fix kernel-doc warnings

PATCH Superseded Randy Dunlap 2 participants 2 messages Nov 10, 2012 – Nov 14, 2012 Rapidio

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rapidio: fix kernel-doc warnings

From: Randy Dunlap <[email protected]>

Fix rapidio kernel-doc warnings:

Warning(drivers/rapidio/rio.c:415): No description found for parameter 'local' Warning(drivers/rapidio/rio.c:415): Excess function parameter 'lstart' description in 'rio_map_inb_region' Warning(include/linux/rio.h:290): No description found for parameter 'switches' Warning(include/linux/rio.h:290): No description found for parameter 'destid_table'

Cc Matt Porter <[email protected]>
Cc Alexandre Bounine <[email protected]>
---
 drivers/rapidio/rio.c |    2 +-
 include/linux/rio.h   |    2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)
include/linux/rio.h +2 -0
@@ -275,9 +275,11 @@ struct rio_id_table {
  * struct rio_net - RIO network info
  * @node: Node in global list of RIO networks
  * @devices: List of devices in this network
+ * @switches: List of switches in this netowrk
  * @mports: List of master ports accessing this network
  * @hport: Default port for accessing this network
  * @id: RIO network ID
+ * @destid_table: destID allocation table
  */
 struct rio_net {
 	struct list_head node;	/* node in list of networks */
drivers/rapidio/rio.c +1 -1
@@ -401,7 +401,7 @@ EXPORT_SYMBOL_GPL(rio_release_inb_pwrite
 /**
  * rio_map_inb_region -- Map inbound memory region.
  * @mport: Master port.
- * @lstart: physical address of memory region to be mapped
+ * @local: physical address of memory region to be mapped
  * @rbase: RIO base address assigned to this window
  * @size: Size of the memory region
  * @rflags: Flags for mapping.
Acked-by on v1 1/1
#1 lore raw
Quoted 37 lines · Randy Dunlap

Fix rapidio kernel-doc warnings:

Warning(drivers/rapidio/rio.c:415): No description found for parameter 'local'
Warning(drivers/rapidio/rio.c:415): Excess function parameter 'lstart' description in 'rio_map_inb_region' Warning(include/linux/rio.h:290): No description found for parameter 'switches'
Warning(include/linux/rio.h:290): No description found for parameter 'destid_table'

Cc Matt Porter <[email protected]>
Cc Alexandre Bounine <[email protected]>
---
 drivers/rapidio/rio.c |    2 +-
 include/linux/rio.h   |    2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)
include/linux/rio.h +2 -0
@@ -275,9 +275,11 @@ struct rio_id_table {
  * struct rio_net - RIO network info
  * @node: Node in global list of RIO networks
  * @devices: List of devices in this network
+ * @switches: List of switches in this netowrk
  * @mports: List of master ports accessing this network
  * @hport: Default port for accessing this network
  * @id: RIO network ID
+ * @destid_table: destID allocation table
  */
 struct rio_net {
 	struct list_head node;	/* node in list of networks */

drivers/rapidio/rio.c EXPORT_SYMBOL_GPL(rio_release_inb_pwrite · line 407

Quoted 8 lines
drivers/rapidio/rio.c +1 -1
@@ -401,7 +401,7 @@ EXPORT_SYMBOL_GPL(rio_release_inb_pwrite
 /**
  * rio_map_inb_region -- Map inbound memory region.
  * @mport: Master port.
- * @lstart: physical address of memory region to be mapped
+ * @local: physical address of memory region to be mapped
  * @rbase: RIO base address assigned to this window
  * @size: Size of the memory region
  * @rflags: Flags for mapping.