[PATCH RESEND net-next] net: tcp: replace the document for "lsndtime" in tcp_sock

[PATCH RESEND net-next] net: tcp: replace the document for "lsndtime" in tcp_sock

[Menglong Dong]

The document for "lsndtime" in struct tcp_sock is placed in the wrong
place, so let's replace it in the proper place.

Fixes: d5fed5addb2b ("tcp: reorganize tcp_sock fast path variables")
Signed-off-by: Menglong Dong <dongml2@chinatelecom.cn>
---
 include/linux/tcp.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/include/linux/tcp.h b/include/linux/tcp.h
index 6a5e08b937b3..f88daaa76d83 100644
--- a/include/linux/tcp.h
+++ b/include/linux/tcp.h
@@ -200,7 +200,6 @@ struct tcp_sock {
 
 	/* TX read-mostly hotpath cache lines */
 	__cacheline_group_begin(tcp_sock_read_tx);
-	/* timestamp of last sent data packet (for restart window) */
 	u32	max_window;	/* Maximal window ever seen from peer	*/
 	u32	rcv_ssthresh;	/* Current window clamp			*/
 	u32	reordering;	/* Packet reordering metric.		*/
@@ -263,7 +262,7 @@ struct tcp_sock {
 	u32	chrono_stat[3];	/* Time in jiffies for chrono_stat stats */
 	u32	write_seq;	/* Tail(+1) of data held in tcp send buffer */
 	u32	pushed_seq;	/* Last pushed seq, required to talk to windows */
-	u32	lsndtime;
+	u32	lsndtime;	/* timestamp of last sent data packet (for restart window) */
 	u32	mdev_us;	/* medium deviation			*/
 	u32	rtt_seq;	/* sequence number to update rttvar	*/
 	u64	tcp_wstamp_ns;	/* departure time for next sent data packet */
-- 
2.39.5

Re: [PATCH RESEND net-next] net: tcp: replace the document for "lsndtime" in tcp_sock

[Jakub Kicinski]

On Wed, 30 Oct 2024 19:31:08 +0800 Menglong Dong wrote:
> Fixes: d5fed5addb2b ("tcp: reorganize tcp_sock fast path variables")

Fixes is for bug fixes. Please drop the fixes tag and add a normal text
reference like:

Commit d5fed5addb2b ("tcp: reorganize tcp_sock fast path variables")
moved the fields around and misplaced the documentation for "lsndtime".
-- 
pw-bot: cr

Re: [PATCH RESEND net-next] net: tcp: replace the document for "lsndtime" in tcp_sock

[Xuan Zhuo]

On Wed, 30 Oct 2024 19:31:08 +0800, Menglong Dong <menglong8.dong@gmail.com> wrote:
> The document for "lsndtime" in struct tcp_sock is placed in the wrong
> place, so let's replace it in the proper place.
>
> Fixes: d5fed5addb2b ("tcp: reorganize tcp_sock fast path variables")
> Signed-off-by: Menglong Dong <dongml2@chinatelecom.cn>

Reviewed-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com>


> ---
>  include/linux/tcp.h | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/include/linux/tcp.h b/include/linux/tcp.h
> index 6a5e08b937b3..f88daaa76d83 100644
> --- a/include/linux/tcp.h
> +++ b/include/linux/tcp.h
> @@ -200,7 +200,6 @@ struct tcp_sock {
>
>  	/* TX read-mostly hotpath cache lines */
>  	__cacheline_group_begin(tcp_sock_read_tx);
> -	/* timestamp of last sent data packet (for restart window) */
>  	u32	max_window;	/* Maximal window ever seen from peer	*/
>  	u32	rcv_ssthresh;	/* Current window clamp			*/
>  	u32	reordering;	/* Packet reordering metric.		*/
> @@ -263,7 +262,7 @@ struct tcp_sock {
>  	u32	chrono_stat[3];	/* Time in jiffies for chrono_stat stats */
>  	u32	write_seq;	/* Tail(+1) of data held in tcp send buffer */
>  	u32	pushed_seq;	/* Last pushed seq, required to talk to windows */
> -	u32	lsndtime;
> +	u32	lsndtime;	/* timestamp of last sent data packet (for restart window) */
>  	u32	mdev_us;	/* medium deviation			*/
>  	u32	rtt_seq;	/* sequence number to update rttvar	*/
>  	u64	tcp_wstamp_ns;	/* departure time for next sent data packet */
> --
> 2.39.5
>
>

Re: [PATCH RESEND net-next] net: tcp: replace the document for "lsndtime" in tcp_sock

[Menglong Dong]

On Mon, Nov 4, 2024 at 7:27 AM Jakub Kicinski <kuba@kernel.org> wrote:
>
> On Wed, 30 Oct 2024 19:31:08 +0800 Menglong Dong wrote:
> > Fixes: d5fed5addb2b ("tcp: reorganize tcp_sock fast path variables")
>
> Fixes is for bug fixes. Please drop the fixes tag and add a normal text
> reference like:

Yeah, I see now. The fix here is just like a typos fix, and no
Fixes tag is needed.

>
> Commit d5fed5addb2b ("tcp: reorganize tcp_sock fast path variables")
> moved the fields around and misplaced the documentation for "lsndtime".

I'll send a V2 with such a comment.

Thanks!
Menglong Dong

> --
> pw-bot: cr