diff mbox series

[v1,13/19] pinctrl: st: Drop wrong kernel doc annotations

Message ID 20211105124242.27288-13-andriy.shevchenko@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series [v1,01/19] lib/string_helpers: Introduce kasprintf_strarray() | expand

Commit Message

Andy Shevchenko Nov. 5, 2021, 12:42 p.m. UTC
Kernel doc validator is not happy:

  .../pinctrl-st.c:59: warning: This comment starts with '/**', but isn't a kernel-doc comment.
  .../pinctrl-st.c:73: warning: This comment starts with '/**', but isn't a kernel-doc comment.

Drop them as they are indeed not a kernel doc comments.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/pinctrl/pinctrl-st.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Linus Walleij Nov. 9, 2021, 11:32 a.m. UTC | #1
On Fri, Nov 5, 2021 at 1:43 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:

> Kernel doc validator is not happy:
>
>   .../pinctrl-st.c:59: warning: This comment starts with '/**', but isn't a kernel-doc comment.
>   .../pinctrl-st.c:73: warning: This comment starts with '/**', but isn't a kernel-doc comment.
>
> Drop them as they are indeed not a kernel doc comments.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Acked-by: Linus Walleij <linus.walleij@linaro.org>

Hm maybe I could just apply this patch, shouldn't collide with anything.
Let me know your preference.

Yours,
Linus Walleij
Andy Shevchenko Nov. 9, 2021, 12:04 p.m. UTC | #2
On Tue, Nov 09, 2021 at 12:32:31PM +0100, Linus Walleij wrote:
> On Fri, Nov 5, 2021 at 1:43 PM Andy Shevchenko
> <andriy.shevchenko@linux.intel.com> wrote:
> 
> > Kernel doc validator is not happy:
> >
> >   .../pinctrl-st.c:59: warning: This comment starts with '/**', but isn't a kernel-doc comment.
> >   .../pinctrl-st.c:73: warning: This comment starts with '/**', but isn't a kernel-doc comment.
> >
> > Drop them as they are indeed not a kernel doc comments.
> >
> > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> 
> Acked-by: Linus Walleij <linus.walleij@linaro.org>
> 
> Hm maybe I could just apply this patch, shouldn't collide with anything.
> Let me know your preference.

You may apply whatever patches you want that are precursors for the strarray()
idea. Basically you may apply somewhat 9 patches if I'm not mistaken.
Of course if you have no objections.
diff mbox series

Patch

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.
  */