Skip to content

Commit

Permalink
net: ipv4: Fix some kerneldoc warnings in TCP Low Priority
Browse files Browse the repository at this point in the history
net//ipv4/tcp_lp.c:120: warning: Function parameter or member 'sk' not described in 'tcp_lp_cong_avoid'
net//ipv4/tcp_lp.c:135: warning: Function parameter or member 'sk' not described in 'tcp_lp_remote_hz_estimator'
net//ipv4/tcp_lp.c:188: warning: Function parameter or member 'sk' not described in 'tcp_lp_owd_calculator'
net//ipv4/tcp_lp.c:222: warning: Function parameter or member 'rtt' not described in 'tcp_lp_rtt_sample'
net//ipv4/tcp_lp.c:222: warning: Function parameter or member 'sk' not described in 'tcp_lp_rtt_sample'
net//ipv4/tcp_lp.c:265: warning: Function parameter or member 'sk' not described in 'tcp_lp_pkts_acked'
net//ipv4/tcp_lp.c:97: warning: Function parameter or member 'sk' not described in 'tcp_lp_init'

There are still a few kerneldoc warnings after this fix.

Signed-off-by: Andrew Lunn <andrew@lunn.ch>
Link: https://lore.kernel.org/r/20201028012703.931632-1-andrew@lunn.ch
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
  • Loading branch information
Andrew Lunn authored and Jakub Kicinski committed Oct 30, 2020
1 parent 0b609b5 commit 726e5e4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions net/ipv4/tcp_lp.c
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ struct lp {

/**
* tcp_lp_init
* @sk: socket to initialize congestion control algorithm for
*
* Init all required variables.
* Clone the handling from Vegas module implementation.
Expand All @@ -111,6 +112,7 @@ static void tcp_lp_init(struct sock *sk)

/**
* tcp_lp_cong_avoid
* @sk: socket to avoid congesting
*
* Implementation of cong_avoid.
* Will only call newReno CA when away from inference.
Expand All @@ -126,6 +128,7 @@ static void tcp_lp_cong_avoid(struct sock *sk, u32 ack, u32 acked)

/**
* tcp_lp_remote_hz_estimator
* @sk: socket which needs an estimate for the remote HZs
*
* Estimate remote HZ.
* We keep on updating the estimated value, where original TCP-LP
Expand Down Expand Up @@ -176,6 +179,7 @@ static u32 tcp_lp_remote_hz_estimator(struct sock *sk)

/**
* tcp_lp_owd_calculator
* @sk: socket to calculate one way delay for
*
* Calculate one way delay (in relative format).
* Original implement OWD as minus of remote time difference to local time
Expand Down Expand Up @@ -210,6 +214,8 @@ static u32 tcp_lp_owd_calculator(struct sock *sk)

/**
* tcp_lp_rtt_sample
* @sk: socket to add a rtt sample to
* @rtt: round trip time, which is ignored!
*
* Implementation or rtt_sample.
* Will take the following action,
Expand Down Expand Up @@ -254,6 +260,7 @@ static void tcp_lp_rtt_sample(struct sock *sk, u32 rtt)

/**
* tcp_lp_pkts_acked
* @sk: socket requiring congestion avoidance calculations
*
* Implementation of pkts_acked.
* Deal with active drop under Early Congestion Indication.
Expand Down

0 comments on commit 726e5e4

Please sign in to comment.