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 <[email protected]>
---
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
On Sun, May 05, 2024 at 01:09:31PM -0700, Jeff Johnson wrote:
> 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 <[email protected]>
Reviewed-by: Simon Horman <[email protected]>
The comment just inside tcp_rtt_estimator is a good read :)
Hello:
This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <[email protected]>:
On Sun, 5 May 2024 13:09:31 -0700 you wrote:
> 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 <[email protected]>
>
> [...]
Here is the summary with links:
- net: dccp: Fix ccid2_rtt_estimator() kernel-doc
https://git.kernel.org/netdev/net-next/c/feb8c2b76eb3
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html