diff mbox series

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

Message ID 20210610132603.597563-1-libaokun1@huawei.com (mailing list archive)
State Accepted
Commit cb8e2e4300fc17e1028cce554ecf72a9e6161742
Delegated to: Netdev Maintainers
Headers show
Series [-next] dccp: tfrc: fix doc warnings in tfrc_equation.c | expand

Checks

Context Check Description
netdev/cover_letter success Link
netdev/fixes_present success Link
netdev/patch_count success Link
netdev/tree_selection success Guessed tree name to be net-next
netdev/subject_prefix warning Target tree name not specified in the subject
netdev/cc_maintainers success CCed 5 of 5 maintainers
netdev/source_inline success Was 0 now: 0
netdev/verify_signedoff success Link
netdev/module_param success Was 0 now: 0
netdev/build_32bit success Errors and warnings before: 1 this patch: 0
netdev/kdoc success Errors and warnings before: 1 this patch: 0
netdev/verify_fixes success Link
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 7 lines checked
netdev/build_allmodconfig_warn success Errors and warnings before: 1 this patch: 0
netdev/header_inline success Link

Commit Message

Baokun Li June 10, 2021, 1:26 p.m. UTC
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 <libaokun1@huawei.com>
---
 net/dccp/ccids/lib/tfrc_equation.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Richard Sailer June 10, 2021, 4:44 p.m. UTC | #1
Just adds a correct comment. Looks fine to me.

Reviewed-by: Richard Sailer <richard_siegfried@systemli.org>

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 <libaokun1@huawei.com>
> ---
>   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.
>    */
>
patchwork-bot+netdevbpf@kernel.org June 10, 2021, 9:10 p.m. UTC | #2
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 <libaokun1@huawei.com>
> 
> [...]

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
diff mbox series

Patch

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