diff mbox series

[2/2] Documentation/gpu: Fix no structured comments warning for drm_gem_ttm_helper.h

Message ID 20190920193558.89815-2-sean@poorly.run (mailing list archive)
State New, archived
Headers show
Series [1/2] drm: Fix duplicate const warning in drm_gem_ttm_helper.c | expand

Commit Message

Sean Paul Sept. 20, 2019, 7:35 p.m. UTC 
From: Sean Paul <seanpaul@chromium.org>

Fixes
include/drm/drm_gem_ttm_helper.h:1: warning: no structured comments found

Fixes: ff540b76f14a ("drm/ttm: add drm gem ttm helpers, starting with drm_gem_ttm_print_info()")
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <maxime.ripard@bootlin.com>
Cc: Sean Paul <sean@poorly.run>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Sean Paul <seanpaul@chromium.org>
---
 Documentation/gpu/drm-mm.rst | 3 ---
 1 file changed, 3 deletions(-)

Comments

Gerd Hoffmann Sept. 23, 2019, 6:59 a.m. UTC | #1 
On Fri, Sep 20, 2019 at 03:35:52PM -0400, Sean Paul wrote:
> From: Sean Paul <seanpaul@chromium.org>
> 
> Fixes
> include/drm/drm_gem_ttm_helper.h:1: warning: no structured comments found

Reviewed-by: Gerd Hoffmann <kraxel@redhat.com>
Thomas Zimmermann Sept. 23, 2019, 7:03 a.m. UTC | #2 
Hi

Am 20.09.19 um 21:35 schrieb Sean Paul:
> From: Sean Paul <seanpaul@chromium.org>
> 
> Fixes
> include/drm/drm_gem_ttm_helper.h:1: warning: no structured comments found

That missing documentation looks like an oversight to me.

Acked-by: Thomas Zimmermann <tzimmermann@suse.de>

under the premise that there's not currently some patch with the missing
documentation floating around.

Best regards
Thomas

> Fixes: ff540b76f14a ("drm/ttm: add drm gem ttm helpers, starting with drm_gem_ttm_print_info()")
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> Cc: Maxime Ripard <maxime.ripard@bootlin.com>
> Cc: Sean Paul <sean@poorly.run>
> Cc: David Airlie <airlied@linux.ie>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: dri-devel@lists.freedesktop.org
> Signed-off-by: Sean Paul <seanpaul@chromium.org>
> ---
>  Documentation/gpu/drm-mm.rst | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
> index 99d56015e077..59619296c84b 100644
> --- a/Documentation/gpu/drm-mm.rst
> +++ b/Documentation/gpu/drm-mm.rst
> @@ -406,9 +406,6 @@ GEM TTM Helper Functions Reference
>  .. kernel-doc:: drivers/gpu/drm/drm_gem_ttm_helper.c
>     :doc: overview
>  
> -.. kernel-doc:: include/drm/drm_gem_ttm_helper.h
> -   :internal:
> -
>  .. kernel-doc:: drivers/gpu/drm/drm_gem_ttm_helper.c
>     :export:
>  
>
Sean Paul Sept. 23, 2019, 2:08 p.m. UTC | #3 
On Mon, Sep 23, 2019 at 08:59:46AM +0200, Gerd Hoffmann wrote:
> On Fri, Sep 20, 2019 at 03:35:52PM -0400, Sean Paul wrote:
> > From: Sean Paul <seanpaul@chromium.org>
> > 
> > Fixes
> > include/drm/drm_gem_ttm_helper.h:1: warning: no structured comments found
> 
> Reviewed-by: Gerd Hoffmann <kraxel@redhat.com>
> 

Thanks, pushed to drm-misc-next

Sean
Daniel Vetter Oct. 8, 2019, 4:36 p.m. UTC | #4 
On Mon, Sep 23, 2019 at 09:03:01AM +0200, Thomas Zimmermann wrote:
> Hi
> 
> Am 20.09.19 um 21:35 schrieb Sean Paul:
> > From: Sean Paul <seanpaul@chromium.org>
> > 
> > Fixes
> > include/drm/drm_gem_ttm_helper.h:1: warning: no structured comments found
> 
> That missing documentation looks like an oversight to me.
> 
> Acked-by: Thomas Zimmermann <tzimmermann@suse.de>
> 
> under the premise that there's not currently some patch with the missing
> documentation floating around.

There's no struct or inline functions in that header file, so really
nothing to document. Just need to make sure that if we add anything, we
re-add the include directive.
-Daniel

> 
> Best regards
> Thomas
> 
> > Fixes: ff540b76f14a ("drm/ttm: add drm gem ttm helpers, starting with drm_gem_ttm_print_info()")
> > Cc: Gerd Hoffmann <kraxel@redhat.com>
> > Cc: Thomas Zimmermann <tzimmermann@suse.de>
> > Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> > Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> > Cc: Maxime Ripard <maxime.ripard@bootlin.com>
> > Cc: Sean Paul <sean@poorly.run>
> > Cc: David Airlie <airlied@linux.ie>
> > Cc: Daniel Vetter <daniel@ffwll.ch>
> > Cc: dri-devel@lists.freedesktop.org
> > Signed-off-by: Sean Paul <seanpaul@chromium.org>
> > ---
> >  Documentation/gpu/drm-mm.rst | 3 ---
> >  1 file changed, 3 deletions(-)
> > 
> > diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
> > index 99d56015e077..59619296c84b 100644
> > --- a/Documentation/gpu/drm-mm.rst
> > +++ b/Documentation/gpu/drm-mm.rst
> > @@ -406,9 +406,6 @@ GEM TTM Helper Functions Reference
> >  .. kernel-doc:: drivers/gpu/drm/drm_gem_ttm_helper.c
> >     :doc: overview
> >  
> > -.. kernel-doc:: include/drm/drm_gem_ttm_helper.h
> > -   :internal:
> > -
> >  .. kernel-doc:: drivers/gpu/drm/drm_gem_ttm_helper.c
> >     :export:
> >  
> > 
> 
> -- 
> Thomas Zimmermann
> Graphics Driver Developer
> SUSE Linux GmbH, Maxfeldstrasse 5, 90409 Nuernberg, Germany
> GF: Felix Imendörffer, Mary Higgins, Sri Rasiah
> HRB 21284 (AG Nürnberg)
>
diff mbox series

Patch

diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
index 99d56015e077..59619296c84b 100644
--- a/Documentation/gpu/drm-mm.rst
+++ b/Documentation/gpu/drm-mm.rst
@@ -406,9 +406,6 @@  GEM TTM Helper Functions Reference
 .. kernel-doc:: drivers/gpu/drm/drm_gem_ttm_helper.c
    :doc: overview
 
-.. kernel-doc:: include/drm/drm_gem_ttm_helper.h
-   :internal:
-
 .. kernel-doc:: drivers/gpu/drm/drm_gem_ttm_helper.c
    :export: