lkml.org 
[lkml]   [2022]   [Jan]   [31]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH] gpio/consumer.h: don't use "/**" for non-kernel-doc comments
From


On 1/31/22 03:24, Linus Walleij wrote:
> On Sun, Jan 30, 2022 at 8:31 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
>> Use "/*" to begin non-kernel-doc comments instead of "/**",
>> which indicates the beginning of kernel-doc notation.
>>
>> Quietens these kernel-doc warnings:
>>
>> consumer.h:13: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>> * Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are
>> consumer.h:13: warning: missing initial short description on line:
>> * Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are
>> consumer.h:22: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>> * Opaque descriptor for a structure of GPIO array attributes. This structure
>> consumer.h:22: warning: missing initial short description on line:
>> * Opaque descriptor for a structure of GPIO array attributes. This structure
>> consumer.h:30: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>> * Struct containing an array of descriptors that can be obtained using
>> consumer.h:30: warning: missing initial short description on line:
>> * Struct containing an array of descriptors that can be obtained using
>> consumer.h:46: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>> * Optional flags that can be passed to one of gpiod_* to configure direction
>> consumer.h:46: warning: missing initial short description on line:
>> * Optional flags that can be passed to one of gpiod_* to configure direction
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Linus Walleij <linus.walleij@linaro.org>
>> Cc: Bartosz Golaszewski <brgl@bgdev.pl>
>> Cc: linux-gpio@vger.kernel.org
>
> In this case the ambition was to provide proper kerneldoc for sure.

Well, the 2 opaque warnings (lines 13 and 22) are just bare "struct gpio_zzz;",
so kernel-doc wouldn't be appropriate there. Those structs are in drivers/gpio/gpiolib.h
(for anyone else who is reading along) -- and not documented there either.

For the other 2 /** warnings, I don't think that I am the right person
to add kernel-doc info for them...

> Is it possible to just fix the documentation?

or just ignore this patch.

--
~Randy

\
 
 \ /
  Last update: 2022-02-01 04:53    [W:0.036 / U:0.476 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site