Re: [PATCH 6/7] docs: Do not include from include/drm/drm_color_mgmt.h

From: Daniel Vetter
Date: Tue Jul 18 2017 - 02:42:54 EST


On Mon, Jul 17, 2017 at 03:00:47PM -0600, Jonathan Corbet wrote:
> Commit 8f2e045ec878 (drm/color: un-inline drm_color_lut_extract()) moved
> the only kerneldoc comment out of include/drm/drm_color_mgmt.h, leading to
> this warning:
>
> ./include/drm/drm_color_mgmt.h:1: warning: no structured comments found
>
> That comment is already picked up in drm_color_mgmt.c, so just delete the
> directive.
>
> CC: dri-devel@xxxxxxxxxxxxxxxxxxxxx
> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
> ---

We have something like this already queued for 4.14, but if you want to
fix all the warnings in 4.13 already I think that makes sense. But I'll
leave that to you and merging through docs-fixes.

Acked-by: Daniel Vetter <daniel.vetter@xxxxxxxx>

> Documentation/gpu/drm-kms.rst | 3 ---
> 1 file changed, 3 deletions(-)
>
> diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst
> index 2d77c9580164..0749000ab3d7 100644
> --- a/Documentation/gpu/drm-kms.rst
> +++ b/Documentation/gpu/drm-kms.rst
> @@ -523,9 +523,6 @@ Color Management Properties
> .. kernel-doc:: drivers/gpu/drm/drm_color_mgmt.c
> :doc: overview
>
> -.. kernel-doc:: include/drm/drm_color_mgmt.h
> - :internal:
> -
> .. kernel-doc:: drivers/gpu/drm/drm_color_mgmt.c
> :export:
>
> --
> 2.9.4
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at http://vger.kernel.org/majordomo-info.html

--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch