2023-11-01 01:46:04

by Yang Li

Subject: [PATCH -next] mcb: Fix some kernel-doc comments

Fix some kernel-doc comments to silence the warnings:
drivers/mcb/mcb-core.c:270: warning: Function parameter or member 'carrier' not described in 'mcb_alloc_bus'
drivers/mcb/mcb-core.c:336: warning: expecting prototype for mcb_bus_put(). Prototype was for mcb_bus_get() instead
drivers/mcb/mcb-core.c:463: warning: Function parameter or member 'mem' not described in 'mcb_release_mem'
drivers/mcb/mcb-core.c:463: warning: Excess function parameter 'dev' description in 'mcb_release_mem'

Reported-by: Abaci Robot <[email protected]>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7105
Signed-off-by: Yang Li <[email protected]>
---
drivers/mcb/mcb-core.c | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/mcb/mcb-core.c b/drivers/mcb/mcb-core.c
index ba4530459de8..7044e96c4434 100644
--- a/drivers/mcb/mcb-core.c
+++ b/drivers/mcb/mcb-core.c
@@ -264,7 +264,7 @@ static void mcb_free_bus(struct device *dev)
/**
* mcb_alloc_bus() - Allocate a new @mcb_bus
*
- * Allocate a new @mcb_bus.
+ * @carrier: pointer to carrier device
*/
struct mcb_bus *mcb_alloc_bus(struct device *carrier)
{
@@ -327,7 +327,7 @@ void mcb_release_bus(struct mcb_bus *bus)
EXPORT_SYMBOL_NS_GPL(mcb_release_bus, MCB);

/**
- * mcb_bus_put() - Increment refcnt
+ * mcb_bus_get() - Increment refcnt
* @bus: The @mcb_bus
*
* Get a @mcb_bus' ref
@@ -455,9 +455,8 @@ EXPORT_SYMBOL_NS_GPL(mcb_request_mem, MCB);

/**
* mcb_release_mem() - Release memory requested by device
- * @dev: The @mcb_device that requested the memory
*
- * Release memory that was prior requested via @mcb_request_mem().
+ * @mem: memory resource
*/
void mcb_release_mem(struct resource *mem)
{
--
2.20.1.7.g153144c

2023-11-01 01:55:56

by Randy Dunlap

Subject: Re: [PATCH -next] mcb: Fix some kernel-doc comments

On 10/31/23 18:44, Yang Li wrote:
> Fix some kernel-doc comments to silence the warnings:
> drivers/mcb/mcb-core.c:270: warning: Function parameter or member 'carrier' not described in 'mcb_alloc_bus'
> drivers/mcb/mcb-core.c:336: warning: expecting prototype for mcb_bus_put(). Prototype was for mcb_bus_get() instead
> drivers/mcb/mcb-core.c:463: warning: Function parameter or member 'mem' not described in 'mcb_release_mem'
> drivers/mcb/mcb-core.c:463: warning: Excess function parameter 'dev' description in 'mcb_release_mem'
>
> Reported-by: Abaci Robot <[email protected]>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7105
> Signed-off-by: Yang Li <[email protected]>
> ---
> drivers/mcb/mcb-core.c | 7 +++----
> 1 file changed, 3 insertions(+), 4 deletions(-)
>

Acked-by: Randy Dunlap <[email protected]>

Thanks.

--
~Randy