linux-kernel - Re: [PATCH] gpio/consumer.h: don't use "/**" for non-kernel-doc comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <d6bb8733-6e6b-0479-d723-0bbdb65ae994@infradead.org>
Date:   Mon, 31 Jan 2022 19:52:39 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Linus Walleij <linus.walleij@...aro.org>
Cc:     linux-kernel@...r.kernel.org, Bartosz Golaszewski <brgl@...ev.pl>,
        linux-gpio@...r.kernel.org
Subject: Re: [PATCH] gpio/consumer.h: don't use "/**" for non-kernel-doc
 comments



On 1/31/22 03:24, Linus Walleij wrote:
> On Sun, Jan 30, 2022 at 8:31 AM Randy Dunlap <rdunlap@...radead.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@...radead.org>
>> Cc: Linus Walleij <linus.walleij@...aro.org>
>> Cc: Bartosz Golaszewski <brgl@...ev.pl>
>> Cc: linux-gpio@...r.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