diff mbox series

[v2,net,07/12] inet: frags: eliminate kernel-doc warning

Message ID 20230712044040.10723-1-rdunlap@infradead.org (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series None | expand

Commit Message

Randy Dunlap July 12, 2023, 4:40 a.m. UTC
Change the anonymous enum kernel-doc content so that it doesn't cause
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(-)

Comments

Jakub Kicinski July 13, 2023, 12:16 a.m. UTC | #1
On Tue, 11 Jul 2023 21:40:40 -0700 Randy Dunlap wrote:
> Change the anonymous enum kernel-doc content so that it doesn't cause
> 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

Could you resend the entire series with the more complex WiFi patches
taken out as well?
Randy Dunlap July 13, 2023, 2:46 a.m. UTC | #2
On 7/12/23 17:16, Jakub Kicinski wrote:
> On Tue, 11 Jul 2023 21:40:40 -0700 Randy Dunlap wrote:
>> Change the anonymous enum kernel-doc content so that it doesn't cause
>> 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
> 
> Could you resend the entire series with the more complex WiFi patches
> taken out as well?

Sure, will do.
diff mbox series

Patch

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
@@ -29,7 +29,7 @@  struct fqdir {
 };
 
 /**
- * fragment queue flags
+ * enum: fragment queue flags
  *
  * @INET_FRAG_FIRST_IN: first fragment has arrived
  * @INET_FRAG_LAST_IN: final fragment has arrived