diff mbox series

[v1,5/6] drm/dp_mst: add kernel-doc for drm_dp_mst_port.fec_capable

Message ID 20200328132025.19910-6-sam@ravnborg.org (mailing list archive)
State New, archived
Headers show
Series drm: kernel-doc stuff | expand

Commit Message

Sam Ravnborg March 28, 2020, 1:20 p.m. UTC
Fix kernel-doc warnings for drm_dp_mst_port.fec_capable.
This fixed the following warning:
drm_dp_mst_helper.h:162: warning: Function parameter or member 'fec_capable' not described in 'drm_dp_mst_port'

Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Cc: David Francis <David.Francis@amd.com>
Cc: Lyude Paul <lyude@redhat.com>
Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Mikita Lipski <mikita.lipski@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
---
 include/drm/drm_dp_mst_helper.h | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Lyude Paul March 30, 2020, 3:01 p.m. UTC | #1
On Sat, 2020-03-28 at 14:20 +0100, Sam Ravnborg wrote:
> Fix kernel-doc warnings for drm_dp_mst_port.fec_capable.
> This fixed the following warning:
> drm_dp_mst_helper.h:162: warning: Function parameter or member 'fec_capable'
> not described in 'drm_dp_mst_port'
> 
> Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
> Cc: David Francis <David.Francis@amd.com>
> Cc: Lyude Paul <lyude@redhat.com>
> Cc: Harry Wentland <harry.wentland@amd.com>
> Cc: Mikita Lipski <mikita.lipski@amd.com>
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> Cc: Maxime Ripard <mripard@kernel.org>
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: David Airlie <airlied@linux.ie>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> ---
>  include/drm/drm_dp_mst_helper.h | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/include/drm/drm_dp_mst_helper.h
> b/include/drm/drm_dp_mst_helper.h
> index bf5e65d2303e..d93e628ebc84 100644
> --- a/include/drm/drm_dp_mst_helper.h
> +++ b/include/drm/drm_dp_mst_helper.h
> @@ -157,6 +157,10 @@ struct drm_dp_mst_port {
>  	 */
>  	bool has_audio;
>  
> +	/**
> +	 * @fec_capable: bool indicating if FEC can be supported
> +	 * up to that point in the MST network.

s/network/topology, but I can just fix that locally and push this in just a
moment. Thanks!

Reviewed-by: Lyude Paul <lyude@redhat.com>

> +	 */
>  	bool fec_capable;
>  };
>
Sam Ravnborg March 30, 2020, 7:05 p.m. UTC | #2
Hi Lyude.

On Mon, Mar 30, 2020 at 11:01:12AM -0400, Lyude Paul wrote:
> On Sat, 2020-03-28 at 14:20 +0100, Sam Ravnborg wrote:
> > Fix kernel-doc warnings for drm_dp_mst_port.fec_capable.
> > This fixed the following warning:
> > drm_dp_mst_helper.h:162: warning: Function parameter or member 'fec_capable'
> > not described in 'drm_dp_mst_port'
> > 
> > Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
> > Cc: David Francis <David.Francis@amd.com>
> > Cc: Lyude Paul <lyude@redhat.com>
> > Cc: Harry Wentland <harry.wentland@amd.com>
> > Cc: Mikita Lipski <mikita.lipski@amd.com>
> > Cc: Alex Deucher <alexander.deucher@amd.com>
> > Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> > Cc: Maxime Ripard <mripard@kernel.org>
> > Cc: Thomas Zimmermann <tzimmermann@suse.de>
> > Cc: David Airlie <airlied@linux.ie>
> > Cc: Daniel Vetter <daniel@ffwll.ch>
> > ---
> >  include/drm/drm_dp_mst_helper.h | 4 ++++
> >  1 file changed, 4 insertions(+)
> > 
> > diff --git a/include/drm/drm_dp_mst_helper.h
> > b/include/drm/drm_dp_mst_helper.h
> > index bf5e65d2303e..d93e628ebc84 100644
> > --- a/include/drm/drm_dp_mst_helper.h
> > +++ b/include/drm/drm_dp_mst_helper.h
> > @@ -157,6 +157,10 @@ struct drm_dp_mst_port {
> >  	 */
> >  	bool has_audio;
> >  
> > +	/**
> > +	 * @fec_capable: bool indicating if FEC can be supported
> > +	 * up to that point in the MST network.
> 
> s/network/topology, but I can just fix that locally and push this in just a
> moment. Thanks!
> 
> Reviewed-by: Lyude Paul <lyude@redhat.com>

Thanks for fixing and applying!

Can you also take a look at PATCH 1/6 and if OK provide your s-o-b
that should follow the Co-developed-by: ...
I know the text has seen a few changes but the original source came from
you.

	Sam
diff mbox series

Patch

diff --git a/include/drm/drm_dp_mst_helper.h b/include/drm/drm_dp_mst_helper.h
index bf5e65d2303e..d93e628ebc84 100644
--- a/include/drm/drm_dp_mst_helper.h
+++ b/include/drm/drm_dp_mst_helper.h
@@ -157,6 +157,10 @@  struct drm_dp_mst_port {
 	 */
 	bool has_audio;
 
+	/**
+	 * @fec_capable: bool indicating if FEC can be supported
+	 * up to that point in the MST network.
+	 */
 	bool fec_capable;
 };