2012-11-10 02:21:42

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] 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'

Signed-off-by: Randy Dunlap <[email protected]>
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(-)

--- 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.


2012-11-14 14:56:44

by Bounine, Alexandre

[permalink] [raw]
Subject: RE: [PATCH] rapidio: fix kernel-doc warnings

On Fri, Nov 09, 2012 10:21 PM
Randy Dunlap <[email protected]> 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 <[email protected]>
> 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(-)
>
> --- 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 <[email protected]>