From: Sam Ravnborg <sam@ravnborg.org>
To: Daniel Vetter <daniel@ffwll.ch>
Cc: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>,
David Airlie <airlied@linux.ie>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
Liviu Dudau <liviu.dudau@arm.com>,
dri-devel@lists.freedesktop.org,
Thomas Zimmermann <tzimmermann@suse.de>
Subject: Re: [PATCH v2 3/3] drm/writeback: wire drm_writeback.h to kernel-doc
Date: Tue, 7 Apr 2020 17:51:55 +0200 [thread overview]
Message-ID: <20200407155155.GB24075@ravnborg.org> (raw)
In-Reply-To: <20200407080851.GH3456981@phenom.ffwll.local>
On Tue, Apr 07, 2020 at 10:08:51AM +0200, Daniel Vetter wrote:
> On Mon, Apr 06, 2020 at 09:47:46PM +0200, Sam Ravnborg wrote:
> > drm_writeback.h included a lot of nice kernel-doc comments.
> > Wire it up so the header file is included in the kernel-doc
> > generated documentation.
> >
> > Added a few simple comments to the two structs so they
> > get picked up by kernel-doc.
> >
> > Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
> > Cc: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
> > Cc: Brian Starkey <brian.starkey@arm.com>
> > Cc: Liviu Dudau <liviu.dudau@arm.com>
> > Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> > Cc: Thomas Zimmermann <tzimmermann@suse.de>
> > Cc: Maxime Ripard <mripard@kernel.org>
> > Cc: Maxime Ripard <mripard@kernel.org>
>
> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Thanks. Applied to drm-misc-next and pushed out.
Sam
> > ---
> > Documentation/gpu/drm-kms.rst | 3 +++
> > include/drm/drm_writeback.h | 9 +++++++++
> > 2 files changed, 12 insertions(+)
> >
> > diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
> > index e1f685015807..397314d08f77 100644
> > --- a/Documentation/gpu/drm-kms.rst
> > +++ b/Documentation/gpu/drm-kms.rst
> > @@ -397,6 +397,9 @@ Connector Functions Reference
> > Writeback Connectors
> > --------------------
> >
> > +.. kernel-doc:: include/drm/drm_writeback.h
> > + :internal:
> > +
> > .. kernel-doc:: drivers/gpu/drm/drm_writeback.c
> > :doc: overview
> >
> > diff --git a/include/drm/drm_writeback.h b/include/drm/drm_writeback.h
> > index 777c14c847f0..9697d2714d2a 100644
> > --- a/include/drm/drm_writeback.h
> > +++ b/include/drm/drm_writeback.h
> > @@ -15,7 +15,13 @@
> > #include <drm/drm_encoder.h>
> > #include <linux/workqueue.h>
> >
> > +/**
> > + * struct drm_writeback_connector - DRM writeback connector
> > + */
> > struct drm_writeback_connector {
> > + /**
> > + * @base: base drm_connector object
> > + */
> > struct drm_connector base;
> >
> > /**
> > @@ -78,6 +84,9 @@ struct drm_writeback_connector {
> > char timeline_name[32];
> > };
> >
> > +/**
> > + * struct drm_writeback_job - DRM writeback job
> > + */
> > struct drm_writeback_job {
> > /**
> > * @connector:
> > --
> > 2.20.1
> >
>
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
prev parent reply other threads:[~2020-04-07 15:52 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-06 19:47 [PATCH v2 0/3] drm: kernel-doc stuff Sam Ravnborg
2020-04-06 19:47 ` [PATCH v2 1/3] drm/vblank: Add intro to documentation Sam Ravnborg
2020-04-06 22:53 ` Lyude Paul
2020-04-07 6:24 ` Thomas Zimmermann
2020-04-07 12:03 ` Liviu Dudau
2020-04-07 14:42 ` Alex Deucher
2020-04-07 16:42 ` Sam Ravnborg
2020-04-06 19:47 ` [PATCH v2 2/3] drm: writeback: document callbacks Sam Ravnborg
2020-04-07 12:04 ` Liviu Dudau
2020-04-07 15:51 ` Sam Ravnborg
2020-04-06 19:47 ` [PATCH v2 3/3] drm/writeback: wire drm_writeback.h to kernel-doc Sam Ravnborg
2020-04-07 8:08 ` Daniel Vetter
2020-04-07 15:51 ` 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=20200407155155.GB24075@ravnborg.org \
--to=sam@ravnborg.org \
--cc=airlied@linux.ie \
--cc=daniel.vetter@ffwll.ch \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=laurent.pinchart+renesas@ideasonboard.com \
--cc=liviu.dudau@arm.com \
--cc=tzimmermann@suse.de \
/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).