public inbox for linux-kernel-mentees@lists.linux-foundation.org
 help / color / mirror / Atom feed
From: Simon Horman <horms@kernel.org>
To: Rakuram Eswaran <rakuram.e96@gmail.com>
Cc: Eric Dumazet <edumazet@google.com>,
	Neal Cardwell <ncardwell@google.com>,
	Kuniyuki Iwashima <kuniyu@google.com>,
	"David S. Miller" <davem@davemloft.net>,
	David Ahern <dsahern@kernel.org>,
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
	hswong3i@gmail.com, hlhung3i@gmail.com, khalid@kernel.org,
	skhan@linuxfoundation.org, david.hunter.linux@gmail.com,
	linux-kernel-mentees@lists.linuxfoundation.org,
	netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] net: tcp_lp: fix kernel-doc warnings and update outdated reference links
Date: Tue, 28 Oct 2025 16:32:26 +0000	[thread overview]
Message-ID: <aQDwGpQttEEsj9ik@horms.kernel.org> (raw)
In-Reply-To: <20251025-net_ipv4_tcp_lp_c-v1-1-058cc221499e@gmail.com>

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>

...

  reply	other threads:[~2025-10-28 16:32 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-25 12:05 [PATCH] net: tcp_lp: fix kernel-doc warnings and update outdated reference links Rakuram Eswaran
2025-10-28 16:32 ` Simon Horman [this message]
2025-10-29  1:20 ` patchwork-bot+netdevbpf

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aQDwGpQttEEsj9ik@horms.kernel.org \
    --to=horms@kernel.org \
    --cc=davem@davemloft.net \
    --cc=david.hunter.linux@gmail.com \
    --cc=dsahern@kernel.org \
    --cc=edumazet@google.com \
    --cc=hlhung3i@gmail.com \
    --cc=hswong3i@gmail.com \
    --cc=khalid@kernel.org \
    --cc=kuba@kernel.org \
    --cc=kuniyu@google.com \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ncardwell@google.com \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=rakuram.e96@gmail.com \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox