net: tcp_lp: fix kernel-doc warnings and update outdated reference links

[PATCH] net: tcp_lp: fix kernel-doc warnings and update outdated reference links

Posted by Rakuram Eswaran 3 months, 2 weeks ago

Fix kernel-doc warnings in tcp_lp.c by adding missing parameter
descriptions for tcp_lp_cong_avoid() and tcp_lp_pkts_acked() when
building with W=1.

Also replace invalid URLs in the file header comment with the currently
valid links to the TCP-LP paper and implementation page.

No functional changes.

Signed-off-by: Rakuram Eswaran <rakuram.e96@gmail.com>
---
Below W=1 build warnings:
net/ipv4/tcp_lp.c:121 function parameter 'ack' not described in 'tcp_lp_cong_avoid'
net/ipv4/tcp_lp.c:121 function parameter 'acked' not described in 'tcp_lp_cong_avoid'
net/ipv4/tcp_lp.c:271 function parameter 'sample' not described in 'tcp_lp_pkts_acked'

The new URLs were verified through archive.org to confirm they match
the content of the original references.
---
 net/ipv4/tcp_lp.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/net/ipv4/tcp_lp.c b/net/ipv4/tcp_lp.c
index 52fe17167460fc433ec84434795f7cbef8144767..976b56644a8a746946e5028dcb054e4c3e249680 100644
--- a/net/ipv4/tcp_lp.c
+++ b/net/ipv4/tcp_lp.c
@@ -23,9 +23,9 @@
  * Original Author:
  *   Aleksandar Kuzmanovic <akuzma@northwestern.edu>
  * Available from:
- *   http://www.ece.rice.edu/~akuzma/Doc/akuzma/TCP-LP.pdf
+ *   https://users.cs.northwestern.edu/~akuzma/doc/TCP-LP-ToN.pdf
  * Original implementation for 2.4.19:
- *   http://www-ece.rice.edu/networks/TCP-LP/
+ *   https://users.cs.northwestern.edu/~akuzma/rice/TCP-LP/linux/tcp-lp-linux.htm
  *
  * 2.6.x module Authors:
  *   Wong Hoi Sing, Edison <hswong3i@gmail.com>
@@ -113,6 +113,8 @@ static void tcp_lp_init(struct sock *sk)
 /**
  * tcp_lp_cong_avoid
  * @sk: socket to avoid congesting
+ * @ack: current ack sequence number
+ * @acked: number of ACKed packets
  *
  * Implementation of cong_avoid.
  * Will only call newReno CA when away from inference.
@@ -261,6 +263,7 @@ static void tcp_lp_rtt_sample(struct sock *sk, u32 rtt)
 /**
  * tcp_lp_pkts_acked
  * @sk: socket requiring congestion avoidance calculations
+ * @sample: ACK sample containing timing and rate information
  *
  * Implementation of pkts_acked.
  * Deal with active drop under Early Congestion Indication.

---
base-commit: 566771afc7a81e343da9939f0bd848d3622e2501
change-id: 20251025-net_ipv4_tcp_lp_c-1f7b4ad40c85

Best regards,
-- 
Rakuram Eswaran <rakuram.e96@gmail.com>

Re: [PATCH] net: tcp_lp: fix kernel-doc warnings and update outdated reference links

Posted by Simon Horman 3 months, 2 weeks ago

On Sat, Oct 25, 2025 at 05:35:18PM +0530, Rakuram Eswaran wrote:
> Fix kernel-doc warnings in tcp_lp.c by adding missing parameter
> descriptions for tcp_lp_cong_avoid() and tcp_lp_pkts_acked() when
> building with W=1.
> 
> Also replace invalid URLs in the file header comment with the currently
> valid links to the TCP-LP paper and implementation page.
> 
> No functional changes.
> 
> Signed-off-by: Rakuram Eswaran <rakuram.e96@gmail.com>
> ---
> Below W=1 build warnings:
> net/ipv4/tcp_lp.c:121 function parameter 'ack' not described in 'tcp_lp_cong_avoid'
> net/ipv4/tcp_lp.c:121 function parameter 'acked' not described in 'tcp_lp_cong_avoid'
> net/ipv4/tcp_lp.c:271 function parameter 'sample' not described in 'tcp_lp_pkts_acked'
> 
> The new URLs were verified through archive.org to confirm they match
> the content of the original references.
> ---
>  net/ipv4/tcp_lp.c | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/net/ipv4/tcp_lp.c b/net/ipv4/tcp_lp.c
> index 52fe17167460fc433ec84434795f7cbef8144767..976b56644a8a746946e5028dcb054e4c3e249680 100644
> --- a/net/ipv4/tcp_lp.c
> +++ b/net/ipv4/tcp_lp.c
> @@ -23,9 +23,9 @@
>   * Original Author:
>   *   Aleksandar Kuzmanovic <akuzma@northwestern.edu>
>   * Available from:
> - *   http://www.ece.rice.edu/~akuzma/Doc/akuzma/TCP-LP.pdf
> + *   https://users.cs.northwestern.edu/~akuzma/doc/TCP-LP-ToN.pdf

It's not important, but FTR, I notice that these
seem to be different versions of the same paper.

>   * Original implementation for 2.4.19:
> - *   http://www-ece.rice.edu/networks/TCP-LP/
> + *   https://users.cs.northwestern.edu/~akuzma/rice/TCP-LP/linux/tcp-lp-linux.htm

It's probably not important, but I think the following would
be a better drop-in replacement. That said, perhaps your choice
is a better one for the purposes of the comment above.

   https://users.cs.northwestern.edu/~akuzma/rice/TCP-LP/

That notwithstanding, this looks good to me.

Reviewed-by: Simon Horman <horms@kernel.org>

...