dccp: tfrc: fix doc warnings in tfrc_equation.c
Subsystems (2)
PATCH 1/1 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'
--- net/dccp/ccids/lib/tfrc_equation.c | 1 + 1 file changed, 1 insertion(+)
net/dccp/ccids/lib/tfrc_equation.c +1 -0
@@ -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. */
Signature · 1 line
2.31.1
Just adds a correct comment. Looks fine to me.
Quoted 23 lines · Baokun Li
Add description for
tfrc_invert_loss_event_rateto 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(+)net/dccp/ccids/lib/tfrc_equation.c +1
-0@@ -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. */
This patch was applied to netdev/net-next.git (refs/heads/master):
Hello:
This patch was applied to netdev/net-next.git (refs/heads/master):
Quoted 8 lines · On Thu, 10 Jun 2021 21:26:03 +0800 you wrote:
Add description for
tfrc_invert_loss_event_rateto 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