All of lore.kernel.org
 help / color / mirror / Atom feed
From: Sam Ravnborg <sam@ravnborg.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>,
	linux-fbdev@vger.kernel.org, dri-devel@lists.freedesktop.org,
	Lee Jones <lee.jones@linaro.org>,
	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>
Subject: Re: [PATCH v3 02/13] video: fbdev: core: Fix kernel-doc warnings in fbmon + fb_notify
Date: Mon, 7 Dec 2020 18:12:57 +0100	[thread overview]
Message-ID: <20201207171235.GA2057731@ravnborg.org> (raw)
In-Reply-To: <d144fe12-8f05-464e-3c1f-272999b39311@infradead.org>

Hi Randy,
> >>
> >> 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
> > 
> 
> I'm not insisting on using Return:
> It can stay the same as the rest of the file IMO.

fb_notify.c contains only the three functions modified in this patch.

So it is consistent within this file, but other fbdev/core/ files uses
RETURNS. git grep shows 5 hits only.

So we will stick with the documented practice here.

	Sam

WARNING: multiple messages have this Message-ID (diff)
From: Sam Ravnborg <sam@ravnborg.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-fbdev@vger.kernel.org, Rich Felker <dalias@libc.org>,
	Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>,
	Peter Zijlstra <peterz@infradead.org>,
	Daniel Vetter <daniel.vetter@ffwll.ch>,
	dri-devel@lists.freedesktop.org,
	Gustavo A R Silva <gustavoars@kernel.org>,
	Andrzej Hajda <a.hajda@samsung.com>,
	Peter Jones <pjones@redhat.com>, Lee Jones <lee.jones@linaro.org>,
	Geert Uytterhoeven <geert+renesas@glider.be>,
	Michael Ellerman <mpe@ellerman.id.au>,
	Alexander Klimov <grandmaster@al2klimov.de>,
	Arnd Bergmann <arnd@arndb.de>,
	Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
	Thomas Winischhofer <thomas@winischhofer.net>,
	linux-arm-kernel@lists.infradead.org,
	Qilong Zhang <zhangqilong3@huawei.com>,
	Douglas Anderson <dianders@chromium.org>,
	Thierry Reding <thierry.reding@gmail.com>,
	Thomas Zimmermann <tzimmermann@suse.de>,
	Colin Ian King <colin.king@canonical.com>,
	Andrew Morton <akpm@linux-foundation.org>,
	Mike Rapoport <rppt@kernel.org>
Subject: Re: [PATCH v3 02/13] video: fbdev: core: Fix kernel-doc warnings in fbmon + fb_notify
Date: Mon, 7 Dec 2020 18:12:57 +0100	[thread overview]
Message-ID: <20201207171235.GA2057731@ravnborg.org> (raw)
In-Reply-To: <d144fe12-8f05-464e-3c1f-272999b39311@infradead.org>

Hi Randy,
> >>
> >> 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
> > 
> 
> I'm not insisting on using Return:
> It can stay the same as the rest of the file IMO.

fb_notify.c contains only the three functions modified in this patch.

So it is consistent within this file, but other fbdev/core/ files uses
RETURNS. git grep shows 5 hits only.

So we will stick with the documented practice here.

	Sam

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

WARNING: multiple messages have this Message-ID (diff)
From: Sam Ravnborg <sam@ravnborg.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-fbdev@vger.kernel.org, Rich Felker <dalias@libc.org>,
	Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>,
	Peter Zijlstra <peterz@infradead.org>,
	Daniel Vetter <daniel.vetter@ffwll.ch>,
	dri-devel@lists.freedesktop.org,
	Gustavo A R Silva <gustavoars@kernel.org>,
	Andrzej Hajda <a.hajda@samsung.com>,
	Peter Jones <pjones@redhat.com>, Lee Jones <lee.jones@linaro.org>,
	Geert Uytterhoeven <geert+renesas@glider.be>,
	Michael Ellerman <mpe@ellerman.id.au>,
	Alexander Klimov <grandmaster@al2klimov.de>,
	Arnd Bergmann <arnd@arndb.de>,
	Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
	Thomas Winischhofer <thomas@winischhofer.net>,
	linux-arm-kernel@lists.infradead.org,
	Qilong Zhang <zhangqilong3@huawei.com>,
	Douglas Anderson <dianders@chromium.org>,
	Thierry Reding <thierry.reding@gmail.com>,
	Thomas Zimmermann <tzimmermann@suse.de>,
	Colin Ian King <colin.king@canonical.com>,
	Andrew Morton <akpm@linux-foundation.org>,
	Mike Rapoport <rppt@kernel.org>
Subject: Re: [PATCH v3 02/13] video: fbdev: core: Fix kernel-doc warnings in fbmon + fb_notify
Date: Mon, 7 Dec 2020 18:12:57 +0100	[thread overview]
Message-ID: <20201207171235.GA2057731@ravnborg.org> (raw)
In-Reply-To: <d144fe12-8f05-464e-3c1f-272999b39311@infradead.org>

Hi Randy,
> >>
> >> 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
> > 
> 
> I'm not insisting on using Return:
> It can stay the same as the rest of the file IMO.

fb_notify.c contains only the three functions modified in this patch.

So it is consistent within this file, but other fbdev/core/ files uses
RETURNS. git grep shows 5 hits only.

So we will stick with the documented practice here.

	Sam
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

  reply	other threads:[~2020-12-07 17:13 UTC|newest]

Thread overview: 108+ 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 ` Sam Ravnborg
2020-12-06 19:02 ` Sam Ravnborg
2020-12-06 19:02 ` [PATCH v3 01/13] video: fbdev: hgafb: Fix kernel-doc warnings Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-06 19:34   ` Randy Dunlap
2020-12-06 19:34     ` Randy Dunlap
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:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-06 19:37   ` Randy Dunlap
2020-12-06 19:37     ` Randy Dunlap
2020-12-06 19:37     ` Randy Dunlap
2020-12-06 20:52     ` Sam Ravnborg
2020-12-06 20:52       ` Sam Ravnborg
2020-12-06 20:52       ` Sam Ravnborg
2020-12-06 21:27       ` Randy Dunlap
2020-12-06 21:27         ` Randy Dunlap
2020-12-06 21:27         ` Randy Dunlap
2020-12-07  8:16     ` Thomas Zimmermann
2020-12-07  8:16       ` Thomas Zimmermann
2020-12-07  8:16       ` Thomas Zimmermann
2020-12-07 16:43       ` Randy Dunlap
2020-12-07 16:43         ` Randy Dunlap
2020-12-07 16:43         ` Randy Dunlap
2020-12-07 17:12         ` Sam Ravnborg [this message]
2020-12-07 17:12           ` Sam Ravnborg
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07  8:17   ` Thomas Zimmermann
2020-12-07  8:17     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07  8:18   ` Thomas Zimmermann
2020-12-07  8:18     ` Thomas Zimmermann
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 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-06 21:19   ` kernel test robot
2020-12-06 21:19     ` kernel test robot
2020-12-06 21:19     ` kernel test robot
2020-12-06 21:48     ` Sam Ravnborg
2020-12-06 21:48       ` Sam Ravnborg
2020-12-06 21:48       ` Sam Ravnborg
2020-12-06 21:49       ` Sam Ravnborg
2020-12-06 21:49         ` Sam Ravnborg
2020-12-06 21:49         ` Sam Ravnborg
2020-12-07  8:19   ` Thomas Zimmermann
2020-12-07  8:19     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07  8:21   ` Thomas Zimmermann
2020-12-07  8:21     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07 13:48   ` Thomas Zimmermann
2020-12-07 13:48     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07 13:49   ` Thomas Zimmermann
2020-12-07 13:49     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07 13:49   ` Thomas Zimmermann
2020-12-07 13:49     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07 13:50   ` Thomas Zimmermann
2020-12-07 13:50     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07 13:51   ` Thomas Zimmermann
2020-12-07 13:51     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07 13:52   ` Thomas Zimmermann
2020-12-07 13:52     ` Thomas Zimmermann
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-06 19:02   ` Sam Ravnborg
2020-12-06 19:02   ` Sam Ravnborg
2020-12-07 13:53   ` Thomas Zimmermann
2020-12-07 13:53     ` Thomas Zimmermann
2020-12-07 13:53     ` Thomas Zimmermann
2020-12-08 18:02 ` [PATCH v3 0/13] drivers/video: W=1 warning fixes Sam Ravnborg
2020-12-08 18:02   ` Sam Ravnborg
2020-12-08 18:02   ` 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=20201207171235.GA2057731@ravnborg.org \
    --to=sam@ravnborg.org \
    --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=mpe@ellerman.id.au \
    --cc=peterz@infradead.org \
    --cc=pjones@redhat.com \
    --cc=rdunlap@infradead.org \
    --cc=rppt@kernel.org \
    --cc=thierry.reding@gmail.com \
    --cc=thomas@winischhofer.net \
    --cc=tzimmermann@suse.de \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.