diff mbox series

[net,12/12] rsi: remove kernel-doc comment marker

Message ID 20230710230312.31197-13-rdunlap@infradead.org (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series net: fix kernel-doc problems in include/net/ | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net
netdev/fixes_present success Fixes tag present in non-next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 1347 this patch: 1347
netdev/cc_maintainers success CCed 9 of 9 maintainers
netdev/build_clang success Errors and warnings before: 1364 this patch: 1364
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 Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 1370 this patch: 1370
netdev/checkpatch warning WARNING: Missing or malformed SPDX-License-Identifier tag in line 1
netdev/kdoc success Errors and warnings before: 2 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Randy Dunlap July 10, 2023, 11:03 p.m. UTC 
Change an errant kernel-doc comment marker (/**) to a regular
comment to prevent a kernel-doc warning.

rsi_91x.h:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Copyright (c) 2017 Redpine Signals Inc.

Fixes: 4c10d56a76bb ("rsi: add header file rsi_91x")
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: Prameela Rani Garnepudi <prameela.j04cs@gmail.com>
Cc: Siva Rebbagondla <siva.rebbagondla@redpinesignals.com>
Cc: Amitkumar Karwar <amit.karwar@redpinesignals.com>
Cc: Kalle Valo <kvalo@kernel.org>
---
 include/net/rsi_91x.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kalle Valo July 11, 2023, 8:58 a.m. UTC | #1 
Randy Dunlap <rdunlap@infradead.org> writes:

> Change an errant kernel-doc comment marker (/**) to a regular
> comment to prevent a kernel-doc warning.
>
> rsi_91x.h:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Copyright (c) 2017 Redpine Signals Inc.
>
> Fixes: 4c10d56a76bb ("rsi: add header file rsi_91x")
> 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: Prameela Rani Garnepudi <prameela.j04cs@gmail.com>
> Cc: Siva Rebbagondla <siva.rebbagondla@redpinesignals.com>
> Cc: Amitkumar Karwar <amit.karwar@redpinesignals.com>
> Cc: Kalle Valo <kvalo@kernel.org>

As wireless trees are closed for July please take this to net tree:

Acked-by: Kalle Valo <kvalo@kernel.org>
Jakub Kicinski July 12, 2023, 3:37 a.m. UTC | #2 
On Mon, 10 Jul 2023 16:03:12 -0700 Randy Dunlap wrote:
> -/**
> +/*
>   * Copyright (c) 2017 Redpine Signals Inc.

I guess the obvious ones like this one can stay, especially since Kalle
already acked it.
diff mbox series

Patch

diff -- a/include/net/rsi_91x.h b/include/net/rsi_91x.h
--- a/include/net/rsi_91x.h
+++ b/include/net/rsi_91x.h
@@ -1,4 +1,4 @@ 
-/**
+/*
  * Copyright (c) 2017 Redpine Signals Inc.
  *
  * Permission to use, copy, modify, and/or distribute this software for any