From: Daniel Bristot de Oliveira <bristot@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-watchdog@vger.kernel.org, linux-kernel@vger.kernel.org,
Wim Van Sebroeck <wim@linux-watchdog.org>,
Guenter Roeck <linux@roeck-us.net>
Subject: Re: [PATCH] watchdog: Improve watchdog_dev function documentation
Date: Wed, 9 Feb 2022 18:01:13 +0100 [thread overview]
Message-ID: <055fcdfe-3e18-0bdc-817a-a51049978803@kernel.org> (raw)
In-Reply-To: <ec5cc9e3-88d4-cc54-0490-7da87b65193b@infradead.org>
On 2/9/22 17:51, Randy Dunlap wrote:
> 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
>
Ack, I will fix that.
Thanks, Randy!
-- Daniel
prev parent reply other threads:[~2022-02-09 17:24 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-09 9:08 Daniel Bristot de Oliveira
2022-02-09 16:51 ` Randy Dunlap
2022-02-09 17:01 ` Daniel Bristot de Oliveira [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=055fcdfe-3e18-0bdc-817a-a51049978803@kernel.org \
--to=bristot@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-watchdog@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=rdunlap@infradead.org \
--cc=wim@linux-watchdog.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®