| Message ID | 20210520184915.588-1-yashsri421@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 503c599a4f53fe3d959aebfd22c34da27da49777 |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | net: encx24j600: fix kernel-doc syntax in file headers | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Guessing tree name failed - patch did not apply |
On 5/20/21 11:49 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for drivers/net/ethernet/microchip/encx24j600 files 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. > For e.g., running scripts/kernel-doc -none > drivers/net/ethernet/microchip/encx24j600_hw.h emits: > warning: expecting prototype for h(). Prototype was for _ENCX24J600_HW_H() instead > > Provide a simple fix by replacing such occurrences with general comment > format, i.e. '/*', to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > drivers/net/ethernet/microchip/encx24j600.c | 2 +- > drivers/net/ethernet/microchip/encx24j600_hw.h | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/drivers/net/ethernet/microchip/encx24j600.c b/drivers/net/ethernet/microchip/encx24j600.c > index 3658c4ae3c37..ee921a99e439 100644 > --- a/drivers/net/ethernet/microchip/encx24j600.c > +++ b/drivers/net/ethernet/microchip/encx24j600.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-or-later > -/** > +/* > * Microchip ENCX24J600 ethernet driver > * > * Copyright (C) 2015 Gridpoint > diff --git a/drivers/net/ethernet/microchip/encx24j600_hw.h b/drivers/net/ethernet/microchip/encx24j600_hw.h > index f604a260ede7..fac61a8fbd02 100644 > --- a/drivers/net/ethernet/microchip/encx24j600_hw.h > +++ b/drivers/net/ethernet/microchip/encx24j600_hw.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0 */ > -/** > +/* > * encx24j600_hw.h: Register definitions > * > */ >
Hello: This patch was applied to netdev/net.git (refs/heads/master): On Fri, 21 May 2021 00:19:15 +0530 you wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for drivers/net/ethernet/microchip/encx24j600 files 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. > For e.g., running scripts/kernel-doc -none > drivers/net/ethernet/microchip/encx24j600_hw.h emits: > warning: expecting prototype for h(). Prototype was for _ENCX24J600_HW_H() instead > > [...] Here is the summary with links: - net: encx24j600: fix kernel-doc syntax in file headers https://git.kernel.org/netdev/net/c/503c599a4f53 You are awesome, thank you! -- Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html
diff --git a/drivers/net/ethernet/microchip/encx24j600.c b/drivers/net/ethernet/microchip/encx24j600.c index 3658c4ae3c37..ee921a99e439 100644 --- a/drivers/net/ethernet/microchip/encx24j600.c +++ b/drivers/net/ethernet/microchip/encx24j600.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-or-later -/** +/* * Microchip ENCX24J600 ethernet driver * * Copyright (C) 2015 Gridpoint diff --git a/drivers/net/ethernet/microchip/encx24j600_hw.h b/drivers/net/ethernet/microchip/encx24j600_hw.h index f604a260ede7..fac61a8fbd02 100644 --- a/drivers/net/ethernet/microchip/encx24j600_hw.h +++ b/drivers/net/ethernet/microchip/encx24j600_hw.h @@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0 */ -/** +/* * encx24j600_hw.h: Register definitions * */
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. The header for drivers/net/ethernet/microchip/encx24j600 files 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. For e.g., running scripts/kernel-doc -none drivers/net/ethernet/microchip/encx24j600_hw.h emits: warning: expecting prototype for h(). Prototype was for _ENCX24J600_HW_H() instead Provide a simple fix by replacing such occurrences with general comment format, i.e. '/*', to prevent kernel-doc from parsing it. Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> --- drivers/net/ethernet/microchip/encx24j600.c | 2 +- drivers/net/ethernet/microchip/encx24j600_hw.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)