[PATCH] pinctrl: st: fix comments compilation warnings

[PATCH] pinctrl: st: fix comments compilation warnings

[Alain Volmat]

This commit fixes 2 compilation warnings due to comment starting with
/** while not being kernel-doc comments.

drivers/pinctrl/pinctrl-st.c:59: warning: This comment starts with '/**',
but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 *  Packed style retime configuration.
drivers/pinctrl/pinctrl-st.c:73: warning: This comment starts with '/**',
but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Dedicated style retime Configuration register

Signed-off-by: Alain Volmat <avolmat@me.com>
---
 drivers/pinctrl/pinctrl-st.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/pinctrl/pinctrl-st.c b/drivers/pinctrl/pinctrl-st.c
index 1482a01dfec7..ae8783b34ed2 100644
--- a/drivers/pinctrl/pinctrl-st.c
+++ b/drivers/pinctrl/pinctrl-st.c
@@ -55,7 +55,7 @@
 #define ST_GPIO_DIRECTION_OUT	0x2
 #define ST_GPIO_DIRECTION_IN	0x4
 
-/**
+/*
  *  Packed style retime configuration.
  *  There are two registers cfg0 and cfg1 in this style for each bank.
  *  Each field in this register is 8 bit corresponding to 8 pins in the bank.
@@ -69,7 +69,7 @@
 #define RT_P_CFG1_CLKNOTDATA_FIELD(reg)		REG_FIELD(reg, 16, 23)
 #define RT_P_CFG1_DOUBLE_EDGE_FIELD(reg)	REG_FIELD(reg, 24, 31)
 
-/**
+/*
  * Dedicated style retime Configuration register
  * each register is dedicated per pin.
  */
-- 
2.25.1


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Re: [PATCH] pinctrl: st: fix comments compilation warnings

[Linus Walleij]

On Sat, Dec 18, 2021 at 10:25 PM Alain Volmat <avolmat@me.com> wrote:

> This commit fixes 2 compilation warnings due to comment starting with
> /** while not being kernel-doc comments.
>
> drivers/pinctrl/pinctrl-st.c:59: warning: This comment starts with '/**',
> but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  *  Packed style retime configuration.
> drivers/pinctrl/pinctrl-st.c:73: warning: This comment starts with '/**',
> but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Dedicated style retime Configuration register
>
> Signed-off-by: Alain Volmat <avolmat@me.com>

This does not apply on my "devel" branch:
https://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-pinctrl.git/log/?h=devel

Please rebase and resend.

Yours,
Linus Walleij

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Re: [PATCH] pinctrl: st: fix comments compilation warnings

[Alain Volmat]

Hi Linus,

apologies. Indeed those two warnings are already fixed in your
devel branch.  This patch is thus no more necessary.

Regards,
Alain

On Mon, Dec 20, 2021 at 03:17:46AM +0100, Linus Walleij wrote:
> On Sat, Dec 18, 2021 at 10:25 PM Alain Volmat <avolmat@me.com> wrote:
> 
> > This commit fixes 2 compilation warnings due to comment starting with
> > /** while not being kernel-doc comments.
> >
> > drivers/pinctrl/pinctrl-st.c:59: warning: This comment starts with '/**',
> > but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  *  Packed style retime configuration.
> > drivers/pinctrl/pinctrl-st.c:73: warning: This comment starts with '/**',
> > but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  * Dedicated style retime Configuration register
> >
> > Signed-off-by: Alain Volmat <avolmat@me.com>
> 
> This does not apply on my "devel" branch:
> https://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-pinctrl.git/log/?h=devel
> 
> Please rebase and resend.
> 
> Yours,
> Linus Walleij

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel