linux-kernel - Re: [PATCH] watchdog: Improve watchdog

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <ec5cc9e3-88d4-cc54-0490-7da87b65193b@infradead.org>
Date:   Wed, 9 Feb 2022 08:51:33 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Daniel Bristot de Oliveira <bristot@...nel.org>,
        Wim Van Sebroeck <wim@...ux-watchdog.org>,
        Guenter Roeck <linux@...ck-us.net>
Cc:     linux-watchdog@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] watchdog: Improve watchdog_dev function documentation

Hi Daniel,

On 2/9/22 01:08, Daniel Bristot de Oliveira wrote:
> Adjust function comments to the kernel doc format. It
> also adjusts some variable names and adds return values.
> 
> No functional change.

After applying the patch, I still see 3 warnings:

watchdog_dev.c:1127: warning: No description found for return value of 'watchdog_dev_register'
watchdog_dev.c:1169: warning: No description found for return value of 'watchdog_set_last_hw_keepalive'
watchdog_dev.c:1197: warning: No description found for return value of 'watchdog_dev_init'


Ah, I see. The format for function Return in kernel-doc is:

 * Return: func return info here

> Cc: Wim Van Sebroeck <wim@...ux-watchdog.org>
> Cc: Guenter Roeck <linux@...ck-us.net>
> Cc: linux-watchdog@...r.kernel.org
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Daniel Bristot de Oliveira <bristot@...nel.org>
> ---
>  drivers/watchdog/watchdog_dev.c | 244 ++++++++++++++++----------------
>  1 file changed, 125 insertions(+), 119 deletions(-)
> 

thanks.
-- 
~Randy