Thread (12 messages) 12 messages, 2 authors, 2021-03-15
STALE1950d

[PATCH 00/10] rsi: fix comment syntax in file headers

From: Aditya Srivastava <hidden>
Date: 2021-03-14 20:19:30
Also in: linux-wireless, lkml, netdev

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.

* The patch series applies perfectly on next-20210312

Aditya Srivastava (10):
  rsi: rsi_boot_params: fix file header comment syntax
  rsi: rsi_coex: fix file header comment syntax
  rsi: rsi_ps: fix file header comment syntax
  rsi: rsi_common: fix file header comment syntax
  rsi: rsi_mgmt: fix file header comment syntax
  rsi: rsi_main: fix file header comment syntax
  rsi: rsi_hal: fix file header comment syntax
  rsi: rsi_debugfs: fix file header comment syntax
  rsi: rsi_sdio: fix file header comment syntax
  rsi: rsi_usb: fix file header comment syntax

 drivers/net/wireless/rsi/rsi_boot_params.h | 2 +-
 drivers/net/wireless/rsi/rsi_coex.h        | 2 +-
 drivers/net/wireless/rsi/rsi_common.h      | 2 +-
 drivers/net/wireless/rsi/rsi_debugfs.h     | 2 +-
 drivers/net/wireless/rsi/rsi_hal.h         | 2 +-
 drivers/net/wireless/rsi/rsi_main.h        | 2 +-
 drivers/net/wireless/rsi/rsi_mgmt.h        | 2 +-
 drivers/net/wireless/rsi/rsi_ps.h          | 2 +-
 drivers/net/wireless/rsi/rsi_sdio.h        | 2 +-
 drivers/net/wireless/rsi/rsi_usb.h         | 2 +-
 10 files changed, 10 insertions(+), 10 deletions(-)

-- 
2.17.1

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help