The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_boot_params.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2014 Redpine Signals Inc."
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing these
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_boot_params.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_ps.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2017 Redpine Signals Inc."
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_ps.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_common.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2014 Redpine Signals Inc."
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_common.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_mgmt.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2014 Redpine Signals Inc."
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_mgmt.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_coex.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2018 Redpine Signals Inc."
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_coex.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_hal.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2017 Redpine Signals Inc."
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_hal.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_main.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2014 Redpine Signals Inc."
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_main.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_debugfs.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2014 Redpine Signals Inc."
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_debugfs.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_sdio.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: Cannot understand * @section LICENSE
on line 2 - I thought it was a doc line"
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_sdio.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header comment used in drivers/net/wireless/rsi/rsi_usb.h
follows kernel-doc syntax, i.e. starts with '/**'. But the content
inside the comment does not comply with kernel-doc specifications (i.e.,
function, struct, etc).
This causes unwelcomed warning from kernel-doc:
"warning: Cannot understand * @section LICENSE
on line 2 - I thought it was a doc line"
Replace this comment syntax with general comment format, i.e. '/*' to
prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/net/wireless/rsi/rsi_usb.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
On Sun, Mar 14, 2021 at 9:18 PM Aditya Srivastava [off-list ref] wrote:
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
There are files in drivers/net/wireless/rsi which follow this syntax in
their file headers, i.e. start with '/**' like comments, which causes
unexpected warnings from kernel-doc.
E.g., running scripts/kernel-doc -none on drivers/net/wireless/rsi/rsi_coex.h
causes this warning:
"warning: wrong kernel-doc identifier on line:
* Copyright (c) 2018 Redpine Signals Inc."
Similarly for other files too.
Provide a simple fix by replacing the kernel-doc like comment syntax with
general format, i.e. "/*", to prevent kernel-doc from parsing it.
Aditya, thanks for starting to clean up the repository following your
investigation on kernel-doc warnings.
The changes to all those files look sound.
However I think these ten patches are really just _one change_, and
hence, all can be put into a single commit.
Hints that suggest it is one change:
- The commit message is pretty much the same (same motivation, same
explanation, same design decisions)
- The change is basically the same (same resulting change in different files)
- All patches are sent to the same responsible people, all of the
patches would be reviewed and accepted by the same people.
- All ten patches can be reviewed at once.
How about merging all ten patches into one patch and sending out a v2.
Lukas