diff mbox series

[v2] 9p/trans_fd: remove Excess kernel-doc comment

Message ID 20240212043341.4631-1-rdunlap@infradead.org (mailing list archive)
State Not Applicable
Delegated to: Netdev Maintainers
Headers show
Series [v2] 9p/trans_fd: remove Excess kernel-doc comment | 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: 990 this patch: 989
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers warning 2 maintainers not CCed: linux_oss@crudebyte.com ericvh@kernel.org
netdev/build_clang success Errors and warnings before: 1007 this patch: 1006
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: 1007 this patch: 1006
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-02-13--00-00 (tests: 1436)

Commit Message

Randy Dunlap Feb. 12, 2024, 4:33 a.m. UTC 
Remove the "@req" kernel-doc description since there is not 'req'
member in the struct p9_conn.

Fixes one kernel-doc warning:
trans_fd.c:133: warning: Excess struct member 'req' description in 'p9_conn'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Eric Van Hensbergen <ericvh@gmail.com>
Cc: Latchesar Ionkov <lucho@ionkov.net>
Cc: Dominique Martinet <asmadeus@codewreck.org>
Cc: v9fs@lists.linux.dev
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Eric Dumazet <edumazet@google.com>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Paolo Abeni <pabeni@redhat.com>
Cc: netdev@vger.kernel.org
Reviewed-by: Simon Horman <horms@kernel.org>
---
v2: add Simon's Reviewed-by;
    rebase & resend;

 net/9p/trans_fd.c |    1 -
 1 file changed, 1 deletion(-)

Comments

Dominique Martinet Feb. 12, 2024, 12:13 p.m. UTC | #1 
Randy Dunlap wrote on Sun, Feb 11, 2024 at 08:33:41PM -0800:
> Remove the "@req" kernel-doc description since there is not 'req'
> member in the struct p9_conn.
> 
> Fixes one kernel-doc warning:
> trans_fd.c:133: warning: Excess struct member 'req' description in 'p9_conn'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Sorry for the lack of reply, I intended to take the patch when the next
""real"" patch comes in but it doesn't look like we'll get much activity
this cycle so I've just queued it up to -next.

Thanks!

FWIW, I contemplated adding
Fixes: 6d35190f3953 ("9p: Rename req to rreq in trans_fd")
but that's basically been forever so I don't think anyone will care
about backports -- and I'm both surprised and ashamed I didn't see this
W=1 warning earlier, I thought I regularly build with that...
diff mbox series

Patch

diff -- a/net/9p/trans_fd.c b/net/9p/trans_fd.c
--- a/net/9p/trans_fd.c
+++ b/net/9p/trans_fd.c
@@ -95,7 +95,6 @@  struct p9_poll_wait {
  * @unsent_req_list: accounting for requests that haven't been sent
  * @rreq: read request
  * @wreq: write request
- * @req: current request being processed (if any)
  * @tmp_buf: temporary buffer to read in header
  * @rc: temporary fcall for reading current frame
  * @wpos: write position for current frame