[PATCH] rapidio: fix kernel-doc warnings

[PATCH] rapidio: fix kernel-doc warnings

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

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'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc:	Matt Porter <mporter@kernel.crashing.org>
Cc:	Alexandre Bounine <alexandre.bounine@idt.com>
---
 drivers/rapidio/rio.c |    2 +-
 include/linux/rio.h   |    2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

--- lnx-37-rc4.orig/include/linux/rio.h
+++ lnx-37-rc4/include/linux/rio.h
@@ -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 */
--- lnx-37-rc4.orig/drivers/rapidio/rio.c
+++ lnx-37-rc4/drivers/rapidio/rio.c
@@ -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.

RE: [PATCH] rapidio: fix kernel-doc warnings

[Bounine, Alexandre]

On Fri, Nov 09, 2012 10:21 PM
Randy Dunlap <rdunlap@infradead.org> wrote:
> 
> 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'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc:	Matt Porter <mporter@kernel.crashing.org>
> Cc:	Alexandre Bounine <alexandre.bounine@idt.com>
> ---
>  drivers/rapidio/rio.c |    2 +-
>  include/linux/rio.h   |    2 ++
>  2 files changed, 3 insertions(+), 1 deletion(-)
> 
> --- lnx-37-rc4.orig/include/linux/rio.h
> +++ lnx-37-rc4/include/linux/rio.h
> @@ -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 */
> --- lnx-37-rc4.orig/drivers/rapidio/rio.c
> +++ lnx-37-rc4/drivers/rapidio/rio.c
> @@ -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: Alexandre Bounine <alexandre.bounine@idt.com>