| Message ID | 20230710230312.31197-8-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | net: fix kernel-doc problems in include/net/ | expand |
On Mon, 10 Jul 2023 16:03:07 -0700 Randy Dunlap wrote: > -/** > +/* > * fragment queue flags Can we do: enum: fragment queue flags instead? This seems to get accepted by ./scripts/kernel-doc and it's nice to keep the "syntax" highlight of the comment, IMHO.
On 7/11/23 20:34, Jakub Kicinski wrote: > On Mon, 10 Jul 2023 16:03:07 -0700 Randy Dunlap wrote: >> -/** >> +/* >> * fragment queue flags > > Can we do: > > enum: fragment queue flags > > instead? This seems to get accepted by ./scripts/kernel-doc and it's > nice to keep the "syntax" highlight of the comment, IMHO. That's not quite kernel-doc syntax but we don't have syntax for an anonymous enum. But you are correct, kernel-doc isn't complaining about it, so OK, I can send a v2. thanks.
diff -- a/include/net/inet_frag.h b/include/net/inet_frag.h --- a/include/net/inet_frag.h +++ b/include/net/inet_frag.h @@ -28,7 +28,7 @@ struct fqdir { struct llist_node free_list; }; -/** +/* * fragment queue flags * * @INET_FRAG_FIRST_IN: first fragment has arrived
Change an errant kernel-doc comment marker (/**) to a regular comment to prevent a kernel-doc warning. inet_frag.h:33: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst Fixes: 1ab1934ed80a ("inet: frags: enum the flag definitions and add descriptions") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> 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: Nikolay Aleksandrov <razor@blackwall.org> --- include/net/inet_frag.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)