diff mbox series

net: dccp: Fix ccid2_rtt_estimator() kernel-doc

Message ID 20240505-ccid2_rtt_estimator-kdoc-v1-1-09231fcb9145@quicinc.com (mailing list archive)
State Accepted
Commit feb8c2b76eb3fae59a1f62451508c98c36db5e3a
Delegated to: Netdev Maintainers
Headers show
Series net: dccp: Fix ccid2_rtt_estimator() kernel-doc | expand

Checks

Context Check Description
netdev/series_format warning Single patches do not need cover letters; Target tree name not specified in the subject
netdev/tree_selection success Guessed tree name to be net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 927 this patch: 926
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 6 of 6 maintainers
netdev/build_clang success Errors and warnings before: 938 this patch: 937
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 938 this patch: 937
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 7 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 1 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-05-07--03-00 (tests: 1000)

Commit Message

Jeff Johnson May 5, 2024, 8:09 p.m. UTC 
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@quicinc.com>
---
 net/dccp/ccids/ccid2.c | 1 +
 1 file changed, 1 insertion(+)


---
base-commit: 2c4d8e19cf060744a9db466ffbaea13ab37f25ca
change-id: 20240505-ccid2_rtt_estimator-kdoc-7346f82e7afd

Comments

Simon Horman May 7, 2024, 7:17 p.m. UTC | #1 
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 <quic_jjohnson@quicinc.com>

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

The comment just inside tcp_rtt_estimator is a good read :)
patchwork-bot+netdevbpf@kernel.org May 7, 2024, 11:20 p.m. UTC | #2 
Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

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 <quic_jjohnson@quicinc.com>
> 
> [...]

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!
diff mbox series

Patch

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),