2009-01-01 04:37:46

by Amos Kong

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

Signed-off-by: Jianjun Kong <[email protected]>
Cc: Matt Porter <[email protected]>

---
drivers/rapidio/rio-driver.c | 3 +--
1 files changed, 1 insertions(+), 2 deletions(-)

diff --git a/drivers/rapidio/rio-driver.c b/drivers/rapidio/rio-driver.c
index 956d3e7..cd6f14e 100644
--- a/drivers/rapidio/rio-driver.c
+++ b/drivers/rapidio/rio-driver.c
@@ -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
--
1.5.6.3


2009-01-01 04:40:17

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] rapidio: fix kernel-doc warning

Jianjun Kong wrote:
> 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.
>
> Signed-off-by: Jianjun Kong <[email protected]>
> Cc: Matt Porter <[email protected]>

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


> ---
> drivers/rapidio/rio-driver.c | 3 +--
> 1 files changed, 1 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/rapidio/rio-driver.c b/drivers/rapidio/rio-driver.c
> index 956d3e7..cd6f14e 100644
> --- a/drivers/rapidio/rio-driver.c
> +++ b/drivers/rapidio/rio-driver.c
> @@ -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


--
~Randy