dccp: tfrc: fix doc warnings in tfrc_equation.c

Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

kernel os linux

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>
Reviewed-by: Richard Sailer <richard_siegfried@systemli.org>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Baokun Li and committed by

David S. Miller 4 years ago cb8e2e43 73e42909

1 changed file

expand all

net

dccp

ccids

lib

tfrc_equation.c

net/dccp/ccids/lib/tfrc_equation.c

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