From: Thomas Zimmermann <tzimmermann@suse.de>
To: Randy Dunlap <rdunlap@infradead.org>,
Sam Ravnborg <sam@ravnborg.org>,
linux-fbdev@vger.kernel.org, dri-devel@lists.freedesktop.org,
Lee Jones <lee.jones@linaro.org>
Cc: Alexander Klimov <grandmaster@al2klimov.de>,
Andrew Morton <akpm@linux-foundation.org>,
Andrzej Hajda <a.hajda@samsung.com>,
Arnd Bergmann <arnd@arndb.de>,
Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
Colin Ian King <colin.king@canonical.com>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
Douglas Anderson <dianders@chromium.org>,
Geert Uytterhoeven <geert+renesas@glider.be>,
Gustavo A R Silva <gustavoars@kernel.org>,
Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>,
linux-arm-kernel@lists.infradead.org,
Michael Ellerman <mpe@ellerman.id.au>,
Mike Rapoport <rppt@kernel.org>, Peter Jones <pjones@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Qilong Zhang <zhangqilong3@huawei.com>,
Rich Felker <dalias@libc.org>,
Thierry Reding <thierry.reding@gmail.com>,
Thomas Winischhofer <thomas@winischhofer.net>,
Tony Prisk <linux@prisktech.co.nz>
Subject: Re: [PATCH v3 02/13] video: fbdev: core: Fix kernel-doc warnings in fbmon + fb_notify
Date: Mon, 7 Dec 2020 09:16:51 +0100 [thread overview]
Message-ID: <dd81dd0e-9701-8332-63eb-2f159c535d02@suse.de> (raw)
In-Reply-To: <0fb6ff8b-bea3-c5bc-0d37-8a5fdab41abc@infradead.org>
[-- Attachment #1.1: Type: text/plain, Size: 3264 bytes --]
Hi
Am 06.12.20 um 20:37 schrieb Randy Dunlap:
> On 12/6/20 11:02 AM, Sam Ravnborg wrote:
>> Fix kernel-doc warnings reported when using W=1
>>
>> v2:
>> - Improve subject (Lee)
>>
>> v3:
>> - Add RETURNS documentation (Thomas)
>
> Hi Sam,
>
> Yes, RETURNS: will work. It just looks like any kernel-doc section name,
> such as Context: or Note:.
> However, the documented format for return info is "Return:".
> (see Documentation/doc-guide/kernel-doc.rst)
Thanks for the note. I asked for RETURNS: because the rest of the file
appears to be using it. Returns: is certainly the better alternative. I
didn't know there was a difference.
Best regards
Thomas
>
>
>> Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
>> Cc: Lee Jones <lee.jones@linaro.org>
>> Cc: Sam Ravnborg <sam@ravnborg.org>
>> Cc: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
>> Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
>> Cc: "Alexander A. Klimov" <grandmaster@al2klimov.de>
>> ---
>> drivers/video/fbdev/core/fb_notify.c | 10 ++++++++++
>> drivers/video/fbdev/core/fbmon.c | 2 +-
>> 2 files changed, 11 insertions(+), 1 deletion(-)
>>
>> diff --git a/drivers/video/fbdev/core/fb_notify.c b/drivers/video/fbdev/core/fb_notify.c
>> index 74c2da528884..4e39c61fae1f 100644
>> --- a/drivers/video/fbdev/core/fb_notify.c
>> +++ b/drivers/video/fbdev/core/fb_notify.c
>> @@ -19,6 +19,9 @@ static BLOCKING_NOTIFIER_HEAD(fb_notifier_list);
>> /**
>> * fb_register_client - register a client notifier
>> * @nb: notifier block to callback on events
>> + *
>> + * RETURNS:
>> + * 0 on success, negative error code on failure.
>> */
>> int fb_register_client(struct notifier_block *nb)
>> {
>> @@ -29,6 +32,9 @@ EXPORT_SYMBOL(fb_register_client);
>> /**
>> * fb_unregister_client - unregister a client notifier
>> * @nb: notifier block to callback on events
>> + *
>> + * RETURNS:
>> + * 0 on success, negative error code on failure.
>> */
>> int fb_unregister_client(struct notifier_block *nb)
>> {
>> @@ -38,7 +44,11 @@ EXPORT_SYMBOL(fb_unregister_client);
>>
>> /**
>> * fb_notifier_call_chain - notify clients of fb_events
>> + * @val: value passed to callback
>> + * @v: pointer passed to callback
>> *
>> + * RETURNS:
>> + * The return value of the last notifier function
>> */
>> int fb_notifier_call_chain(unsigned long val, void *v)
>> {
>> diff --git a/drivers/video/fbdev/core/fbmon.c b/drivers/video/fbdev/core/fbmon.c
>> index 1bf82dbc9e3c..b0e690f41025 100644
>> --- a/drivers/video/fbdev/core/fbmon.c
>> +++ b/drivers/video/fbdev/core/fbmon.c
>> @@ -605,6 +605,7 @@ static void get_detailed_timing(unsigned char *block,
>> * fb_create_modedb - create video mode database
>> * @edid: EDID data
>> * @dbsize: database size
>> + * @specs: monitor specifications, may be NULL
>> *
>> * RETURNS: struct fb_videomode, @dbsize contains length of database
>> *
>
>
--
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Maxfeldstr. 5, 90409 Nürnberg, Germany
(HRB 36809, AG Nürnberg)
Geschäftsführer: Felix Imendörffer
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 840 bytes --]
next prev parent reply other threads:[~2020-12-07 8:17 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-06 19:02 [PATCH v3 0/13] drivers/video: W=1 warning fixes Sam Ravnborg
2020-12-06 19:02 ` [PATCH v3 01/13] video: fbdev: hgafb: Fix kernel-doc warnings Sam Ravnborg
2020-12-06 19:34 ` Randy Dunlap
2020-12-06 19:02 ` [PATCH v3 02/13] video: fbdev: core: Fix kernel-doc warnings in fbmon + fb_notify Sam Ravnborg
2020-12-06 19:37 ` Randy Dunlap
2020-12-06 20:52 ` Sam Ravnborg
2020-12-06 21:27 ` Randy Dunlap
2020-12-07 8:16 ` Thomas Zimmermann [this message]
2020-12-07 16:43 ` Randy Dunlap
2020-12-07 17:12 ` Sam Ravnborg
2020-12-06 19:02 ` [PATCH v3 03/13] video: fbdev: omapfb: Fix set but not used warnings in hdmi*_core Sam Ravnborg
2020-12-07 8:17 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 04/13] video: fbdev: uvesafb: Fix set but not used warning Sam Ravnborg
2020-12-07 8:18 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 05/13] sh: Fix set but not used warnings with !CONFIG_MMU Sam Ravnborg
2020-12-06 21:19 ` kernel test robot
2020-12-06 21:48 ` Sam Ravnborg
2020-12-06 21:49 ` Sam Ravnborg
2020-12-07 8:19 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 06/13] video: fbdev: sparc drivers: fix kernel-doc warnings for blank_mode Sam Ravnborg
2020-12-07 8:21 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 07/13] video: fbdev: mmp: Fix kernel-doc warning for lcd_spi_write Sam Ravnborg
2020-12-07 13:48 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 08/13] video: fbdev: wmt_ge_rops: Fix function not declared warnings Sam Ravnborg
2020-12-07 13:49 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 09/13] video: fbdev: goldfishfb: Fix defined but not used warning Sam Ravnborg
2020-12-07 13:49 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 10/13] video: fbdev: gbefb: Fix set " Sam Ravnborg
2020-12-07 13:50 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 11/13] video: fbdev: efifb: Fix set but not used warning for screen_pitch Sam Ravnborg
2020-12-07 13:51 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 12/13] video: fbdev: controlfb: Fix set but not used warnings Sam Ravnborg
2020-12-07 13:52 ` Thomas Zimmermann
2020-12-06 19:02 ` [PATCH v3 13/13] video: fbdev: sis: Drop useless call to SiS_GetResInfo() Sam Ravnborg
2020-12-07 13:53 ` Thomas Zimmermann
2020-12-08 18:02 ` [PATCH v3 0/13] drivers/video: W=1 warning fixes Sam Ravnborg
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=dd81dd0e-9701-8332-63eb-2f159c535d02@suse.de \
--to=tzimmermann@suse.de \
--cc=a.hajda@samsung.com \
--cc=akpm@linux-foundation.org \
--cc=arnd@arndb.de \
--cc=b.zolnierkie@samsung.com \
--cc=colin.king@canonical.com \
--cc=dalias@libc.org \
--cc=daniel.vetter@ffwll.ch \
--cc=dianders@chromium.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=geert+renesas@glider.be \
--cc=grandmaster@al2klimov.de \
--cc=gustavoars@kernel.org \
--cc=kuninori.morimoto.gx@renesas.com \
--cc=lee.jones@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-fbdev@vger.kernel.org \
--cc=linux@prisktech.co.nz \
--cc=mpe@ellerman.id.au \
--cc=peterz@infradead.org \
--cc=pjones@redhat.com \
--cc=rdunlap@infradead.org \
--cc=rppt@kernel.org \
--cc=sam@ravnborg.org \
--cc=thierry.reding@gmail.com \
--cc=thomas@winischhofer.net \
--cc=zhangqilong3@huawei.com \
/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;
as well as URLs for NNTP newsgroup(s).