[Intel-gfx] [PATCH 4/8] drm/i915: Add kerneldoc comments to the intel_context struct

[Daniel Vetter]

On Thu, Jul 03, 2014 at 03:38:34PM +0000, Mateo Lozano, Oscar wrote:
> > -----Original Message-----
> > From: Intel-gfx [mailto:intel-gfx-bounces at lists.freedesktop.org] On Behalf
> > Of oscar.mateo at intel.com
> > Sent: Thursday, July 03, 2014 4:28 PM
> > To: intel-gfx at lists.freedesktop.org
> > Subject: [Intel-gfx] [PATCH 4/8] drm/i915: Add kerneldoc comments to the
> > intel_context struct
> > 
> > From: Oscar Mateo <oscar.mateo at intel.com>
> > 
> > A bit of background on the context elements.
> > 
> > Cc: Jesse Barnes <jbarnes at virtuousgeek.org>
> > Signed-off-by: Oscar Mateo <oscar.mateo at intel.com>
> > ---
> >  drivers/gpu/drm/i915/i915_drv.h | 15 +++++++++++++++
> >  1 file changed, 15 insertions(+)
> > 
> > diff --git a/drivers/gpu/drm/i915/i915_drv.h
> > b/drivers/gpu/drm/i915/i915_drv.h index 1cebefc..6289d46 100644
> > --- a/drivers/gpu/drm/i915/i915_drv.h
> > +++ b/drivers/gpu/drm/i915/i915_drv.h
> > @@ -585,6 +585,21 @@ struct i915_ctx_hang_stats {
> > 
> >  /* This must match up with the value previously used for execbuf2.rsvd1. */
> > #define DEFAULT_CONTEXT_HANDLE 0
> > +/**
> > + * struct intel_context - as the name implies, represents a context.
> > + * @ref: reference count.
> > + * @user_handle: userspace tracking identity for this context.
> > + * @remap_slice: l3 row remapping information.
> > + * @file_priv: filp associated with this context (NULL for global default
> > context).
> > + * @hang_stats: information about the role of this context in possible GPU
> > hangs.
> > + * @vm: virtual memory space used by this context.
> > + * @legacy_hw_ctx: render context backing object and whether it is
> > correctly
> > + *                initialized (legacy ring submission mechanism only).
> 
> Jesse: do you know how to comment this? According to the kerneldoc howto
> "Nesting of declarations is not supported" and I couldn´t find a similar
> construct with kdoc comments anywhere :(

kerneldoc sucks a bit unfortunately. Unfortunately also no concrete plans
to fix it all up.
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch