diff mbox

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

Message ID 20170717210048.16400-7-corbet@lwn.net (mailing list archive)
State New, archived
Headers show

Commit Message

Jonathan Corbet July 17, 2017, 9 p.m. UTC
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@lists.freedesktop.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/gpu/drm-kms.rst | 3 ---
 1 file changed, 3 deletions(-)

Comments

Daniel Vetter July 18, 2017, 6:42 a.m. UTC | #1
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@lists.freedesktop.org
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---

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@ffwll.ch>

>  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@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jonathan Corbet July 18, 2017, 1:09 p.m. UTC | #2
On Tue, 18 Jul 2017 08:42:42 +0200
Daniel Vetter <daniel@ffwll.ch> 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@lists.freedesktop.org
> > Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> > ---  
> 
> 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.

4.14 was my plan too; I think I've sent Linus enough churn for this cycle
already...:)  Since you have it queued, I'll just drop mine.  Plenty of
other warnings to beat my head against.

Thanks,

jon
diff mbox

Patch

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: