linux-kernel - Re: [PATCH] reset: fix kernel-doc warnings

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: Windows password security audit tool. GUI, reports in PDF.

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

Date:   Thu, 24 Oct 2019 08:26:03 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Philipp Zabel <p.zabel@...gutronix.de>,
        LKML <linux-kernel@...r.kernel.org>
Cc:     "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>
Subject: Re: [PATCH] reset: fix kernel-doc warnings

On 10/24/19 1:47 AM, Philipp Zabel wrote:
> Hi Randy,
> 
> thank you for the fixes.
> 
> On Tue, 2019-10-22 at 20:57 -0700, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@...radead.org>
>>
>> Fix kernel-doc warnings discovered in the reset controller API chapter.
>> Fixes these warnings:
>>
>> ./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
>> ./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format:  * of_reset_control_get_count - Count number of resets available with a device
>> ./drivers/reset/core.c:838: warning: Function parameter or member 'node' not described in 'of_reset_control_get_count'
>> ./include/linux/reset-controller.h:45: warning: Function parameter or member 'con_id' not described in 'reset_control_lookup'
>> ./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
>> ./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format:  * of_reset_control_get_count - Count number of resets available with a device
>>
>> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
>> Cc: Philipp Zabel <p.zabel@...gutronix.de>
>> ---
>>  drivers/reset/core.c             |    4 ++--
>>  include/linux/reset-controller.h |    4 ++--
> [...]
>> @@ -7,7 +7,7 @@
>>  struct reset_controller_dev;
>>  
>>  /**
>> - * struct reset_control_ops
>> + * struct reset_control_ops - reset controller driver callbacks
>>   *
>>   * @reset: for self-deasserting resets, does all necessary
>>   *         things to reset the device
> 
> This is all that remains when I rebase onto reset/fixes. Ok to apply
> this and change the commit message to:
> 
>   reset: fix reset_control_ops kerneldoc comment
> 
>   Add a missing short description to the reset_control_ops
>   documentation.
> 
> ?

Of course.  Go for it.

-- 
~Randy