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

[Daniel Vetter]

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 at 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 at 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 at redhat.com>
> > Cc: Thomas Zimmermann <tzimmermann at suse.de>
> > Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
> > Cc: Maarten Lankhorst <maarten.lankhorst at linux.intel.com>
> > Cc: Maxime Ripard <maxime.ripard at bootlin.com>
> > Cc: Sean Paul <sean at poorly.run>
> > Cc: David Airlie <airlied at linux.ie>
> > Cc: Daniel Vetter <daniel at ffwll.ch>
> > Cc: dri-devel at lists.freedesktop.org
> > Signed-off-by: Sean Paul <seanpaul at 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)
> 




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