Messages in this thread Patch in this message | | | From | Aditya Srivastava <> | Subject | [PATCH] gpio: fix kernel-doc syntax in file header | Date | Tue, 18 May 2021 23:23:39 +0530 |
| |
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. The header for include/linux/nsc_gpio.h follows this syntax, but the content inside does not comply with kernel-doc.
This line was probably not meant for kernel-doc parsing, but is parsed due to the presence of kernel-doc like comment syntax(i.e, '/**'), which causes unexpected warning from kernel-doc: warning: Cannot understand nsc_gpio.c on line 3 - I thought it was a doc line
Provide a simple fix by replacing this occurrence with general comment format, i.e. '/*', to prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> --- * Applies perfectly on next-20210514
include/linux/nsc_gpio.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/nsc_gpio.h b/include/linux/nsc_gpio.h index d7a04a6e3783..342ce97975e8 100644 --- a/include/linux/nsc_gpio.h +++ b/include/linux/nsc_gpio.h @@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0 */ -/** +/* nsc_gpio.c National Semiconductor GPIO common access methods. -- 2.17.1
| |