From: Sam Ravnborg <sam@ravnborg.org>
To: Douglas Anderson <dianders@chromium.org>
Cc: David Airlie <airlied@linux.ie>,
Thierry Reding <thierry.reding@gmail.com>,
linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org
Subject: Re: [PATCH] drm: panel: Fully transition panel_desc kerneldoc to inline style
Date: Sat, 5 Dec 2020 20:24:47 +0100 [thread overview]
Message-ID: <20201205192447.GD332836@ravnborg.org> (raw)
In-Reply-To: <20201201125822.1.I3c4191336014bd57364309439e56f600c94bb12b@changeid>
Hi Douglas,
On Tue, Dec 01, 2020 at 12:59:12PM -0800, Douglas Anderson wrote:
> In commit 131f909ad55f ("drm: panel: simple: Fixup the struct
> panel_desc kernel doc") I transitioned the more deeply nested
> kerneldoc comments into the inline style. Apparently it is desirable
> to continue the job and move _everything_ in this struct to inline.
> Let's do it.
>
> While doing this, we also add a short summary for the whole struct to
> fix a warning when we run with extra warnings, AKA:
> scripts/kernel-doc -v -rst drivers/gpu/drm/panel/panel-simple.c
>
> The warning was:
> drivers/gpu/drm/panel/panel-simple.c:42: warning: missing initial short description on line:
> * struct panel_desc
>
> Suggested-by: Sam Ravnborg <sam@ravnborg.org>
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> Cc: Douglas Anderson <dianders@chromium.org>
> Cc: Sam Ravnborg <sam@ravnborg.org>
> Cc: Thierry Reding <thierry.reding@gmail.com>
> Cc: dri-devel@lists.freedesktop.org
> ---
>
> drivers/gpu/drm/panel/panel-simple.c | 43 +++++++++++++++++-----------
> 1 file changed, 27 insertions(+), 16 deletions(-)
>
> diff --git a/drivers/gpu/drm/panel/panel-simple.c b/drivers/gpu/drm/panel/panel-simple.c
> index 216cde33b5c4..33d53abdb1fb 100644
> --- a/drivers/gpu/drm/panel/panel-simple.c
> +++ b/drivers/gpu/drm/panel/panel-simple.c
> @@ -39,31 +39,36 @@
> #include <drm/drm_panel.h>
>
> /**
> - * struct panel_desc
> - * @modes: Pointer to array of fixed modes appropriate for this panel. If
> - * only one mode then this can just be the address of this the mode.
While applying I fixed this up like this:
> - * only one mode then this can just be the address of the mode.
Applied to drm-misc-next - thanks for doing this. Much nicer now.
Sam
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
prev parent reply other threads:[~2020-12-05 19:24 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-01 20:59 [PATCH] drm: panel: Fully transition panel_desc kerneldoc to inline style Douglas Anderson
2020-12-05 19:24 ` Sam Ravnborg [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=20201205192447.GD332836@ravnborg.org \
--to=sam@ravnborg.org \
--cc=airlied@linux.ie \
--cc=dianders@chromium.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-kernel@vger.kernel.org \
--cc=thierry.reding@gmail.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).