2021-06-10 13:19:04

by Baokun Li

Subject: [PATCH -next] dccp: tfrc: fix doc warnings in tfrc_equation.c

Add description for `tfrc_invert_loss_event_rate` to fix the W=1 warnings:

net/dccp/ccids/lib/tfrc_equation.c:695: warning: Function parameter or
member 'loss_event_rate' not described in 'tfrc_invert_loss_event_rate'

Signed-off-by: Baokun Li <[email protected]>
---
net/dccp/ccids/lib/tfrc_equation.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/net/dccp/ccids/lib/tfrc_equation.c b/net/dccp/ccids/lib/tfrc_equation.c
index e2a337fa9ff7..92a8c6bea316 100644
--- a/net/dccp/ccids/lib/tfrc_equation.c
+++ b/net/dccp/ccids/lib/tfrc_equation.c
@@ -688,6 +688,7 @@ u32 tfrc_calc_x_reverse_lookup(u32 fvalue)

/**
* tfrc_invert_loss_event_rate - Compute p so that 10^6 corresponds to 100%
+ * @loss_event_rate: loss event rate to invert
* When @loss_event_rate is large, there is a chance that p is truncated to 0.
* To avoid re-entering slow-start in that case, we set p = TFRC_SMALLEST_P > 0.
*/
--
2.31.1

2021-06-10 16:56:02

by Richard Sailer

Subject: Re: [PATCH -next] dccp: tfrc: fix doc warnings in tfrc_equation.c

Just adds a correct comment. Looks fine to me.

Reviewed-by: Richard Sailer <[email protected]>

On 10/06/2021 15:26, Baokun Li wrote:
> Add description for `tfrc_invert_loss_event_rate` to fix the W=1 warnings:
>
> net/dccp/ccids/lib/tfrc_equation.c:695: warning: Function parameter or
> member 'loss_event_rate' not described in 'tfrc_invert_loss_event_rate'
>
> Signed-off-by: Baokun Li <[email protected]>
> ---
> net/dccp/ccids/lib/tfrc_equation.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/net/dccp/ccids/lib/tfrc_equation.c b/net/dccp/ccids/lib/tfrc_equation.c
> index e2a337fa9ff7..92a8c6bea316 100644
> --- a/net/dccp/ccids/lib/tfrc_equation.c
> +++ b/net/dccp/ccids/lib/tfrc_equation.c
> @@ -688,6 +688,7 @@ u32 tfrc_calc_x_reverse_lookup(u32 fvalue)
>
> /**
> * tfrc_invert_loss_event_rate - Compute p so that 10^6 corresponds to 100%
> + * @loss_event_rate: loss event rate to invert
> * When @loss_event_rate is large, there is a chance that p is truncated to 0.
> * To avoid re-entering slow-start in that case, we set p = TFRC_SMALLEST_P > 0.
> */
>

2021-06-10 21:14:13

by patchwork-bot+netdevbpf

Subject: Re: [PATCH -next] dccp: tfrc: fix doc warnings in tfrc_equation.c

Hello:

This patch was applied to netdev/net-next.git (refs/heads/master):

On Thu, 10 Jun 2021 21:26:03 +0800 you wrote:
> Add description for `tfrc_invert_loss_event_rate` to fix the W=1 warnings:
>
> net/dccp/ccids/lib/tfrc_equation.c:695: warning: Function parameter or
> member 'loss_event_rate' not described in 'tfrc_invert_loss_event_rate'
>
> Signed-off-by: Baokun Li <[email protected]>
>
> [...]

Here is the summary with links:
- [-next] dccp: tfrc: fix doc warnings in tfrc_equation.c
https://git.kernel.org/netdev/net-next/c/cb8e2e4300fc

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html