[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-ID: <20240505-ccid2_rtt_estimator-kdoc-v1-1-09231fcb9145@quicinc.com>
Date: Sun, 5 May 2024 13:09:31 -0700
From: Jeff Johnson <quic_jjohnson@...cinc.com>
To: "David S. Miller" <davem@...emloft.net>,
Eric Dumazet
<edumazet@...gle.com>, Jakub Kicinski <kuba@...nel.org>,
Paolo Abeni
<pabeni@...hat.com>
CC: <dccp@...r.kernel.org>, <netdev@...r.kernel.org>,
<linux-kernel@...r.kernel.org>,
Jeff Johnson <quic_jjohnson@...cinc.com>
Subject: [PATCH] net: dccp: Fix ccid2_rtt_estimator() kernel-doc
make C=1 reports:
warning: Function parameter or struct member 'mrtt' not described in 'ccid2_rtt_estimator'
So document the 'mrtt' parameter.
Signed-off-by: Jeff Johnson <quic_jjohnson@...cinc.com>
---
net/dccp/ccids/ccid2.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/net/dccp/ccids/ccid2.c b/net/dccp/ccids/ccid2.c
index 4d9823d6dced..d6b30700af67 100644
--- a/net/dccp/ccids/ccid2.c
+++ b/net/dccp/ccids/ccid2.c
@@ -353,6 +353,7 @@ static void ccid2_hc_tx_packet_sent(struct sock *sk, unsigned int len)
/**
* ccid2_rtt_estimator - Sample RTT and compute RTO using RFC2988 algorithm
* @sk: socket to perform estimator on
+ * @mrtt: measured RTT
*
* This code is almost identical with TCP's tcp_rtt_estimator(), since
* - it has a higher sampling frequency (recommended by RFC 1323),
---
base-commit: 2c4d8e19cf060744a9db466ffbaea13ab37f25ca
change-id: 20240505-ccid2_rtt_estimator-kdoc-7346f82e7afd
Powered by blists - more mailing lists