2022-05-26 17:21:24

by Yang Li

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

Make @freq to @bw in dev_pm_opp_find_bw_ceil() and
dev_pm_opp_find_bw_floor() kernel-doc comment to
remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.

drivers/opp/core.c:753: warning: Function parameter or member 'bw' not
described in 'dev_pm_opp_find_bw_ceil'
drivers/opp/core.c:753: warning: Excess function parameter 'freq'
description in 'dev_pm_opp_find_bw_ceil'
drivers/opp/core.c:812: warning: Function parameter or member 'bw' not
described in 'dev_pm_opp_find_bw_floor'
drivers/opp/core.c:812: warning: Excess function parameter 'freq'
description in 'dev_pm_opp_find_bw_floor'

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
drivers/opp/core.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/opp/core.c b/drivers/opp/core.c
index 84063eaebb91..e44b73af2824 100644
--- a/drivers/opp/core.c
+++ b/drivers/opp/core.c
@@ -732,7 +732,7 @@ EXPORT_SYMBOL_GPL(dev_pm_opp_find_level_ceil);
/**
* dev_pm_opp_find_bw_ceil() - Search for a rounded ceil bandwidth
* @dev: device for which we do this operation
- * @freq: start bandwidth
+ * @bw: start bandwidth
* @index: which bandwidth to compare, in case of OPPs with several values
*
* Search for the matching floor *available* OPP from a starting bandwidth
@@ -791,7 +791,7 @@ EXPORT_SYMBOL_GPL(dev_pm_opp_find_bw_ceil);
/**
* dev_pm_opp_find_bw_floor() - Search for a rounded floor bandwidth
* @dev: device for which we do this operation
- * @freq: start bandwidth
+ * @bw: start bandwidth
* @index: which bandwidth to compare, in case of OPPs with several values
*
* Search for the matching floor *available* OPP from a starting bandwidth
--
2.20.1.7.g153144c

2022-05-28 19:48:11

by Viresh Kumar

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

On 26-05-22, 21:20, Yang Li wrote:
> Make @freq to @bw in dev_pm_opp_find_bw_ceil() and
> dev_pm_opp_find_bw_floor() kernel-doc comment to
> remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
>
> drivers/opp/core.c:753: warning: Function parameter or member 'bw' not
> described in 'dev_pm_opp_find_bw_ceil'
> drivers/opp/core.c:753: warning: Excess function parameter 'freq'
> description in 'dev_pm_opp_find_bw_ceil'
> drivers/opp/core.c:812: warning: Function parameter or member 'bw' not
> described in 'dev_pm_opp_find_bw_floor'
> drivers/opp/core.c:812: warning: Excess function parameter 'freq'
> description in 'dev_pm_opp_find_bw_floor'
>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
> ---
> drivers/opp/core.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)

Applied. Thanks.

--
viresh