From mboxrd@z Thu Jan  1 00:00:00 1970
From: Daniel Vetter <daniel@ffwll.ch>
Subject: Re: [PATCH 4/8] drm/i915: Add kerneldoc comments to the
 intel_context struct
Date: Tue, 8 Jul 2014 11:29:17 +0200
Message-ID: <20140708092917.GS17271@phenom.ffwll.local>
References: <1404401285-19918-1-git-send-email-oscar.mateo@intel.com>
 <1404401285-19918-4-git-send-email-oscar.mateo@intel.com>
 <92648605EABDA246B775AAB04C95A7A3137EC682@IRSMSX103.ger.corp.intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Return-path: <intel-gfx-bounces@lists.freedesktop.org>
Received: from mail-wi0-f180.google.com (mail-wi0-f180.google.com
 [209.85.212.180])
 by gabe.freedesktop.org (Postfix) with ESMTP id 276F26E093
 for <intel-gfx@lists.freedesktop.org>; Tue,  8 Jul 2014 02:29:07 -0700 (PDT)
Received: by mail-wi0-f180.google.com with SMTP id hi2so602752wib.13
 for <intel-gfx@lists.freedesktop.org>; Tue, 08 Jul 2014 02:29:06 -0700 (PDT)
Content-Disposition: inline
In-Reply-To: <92648605EABDA246B775AAB04C95A7A3137EC682@IRSMSX103.ger.corp.intel.com>
List-Unsubscribe: <http://lists.freedesktop.org/mailman/options/intel-gfx>,
 <mailto:intel-gfx-request@lists.freedesktop.org?subject=unsubscribe>
List-Archive: <http://lists.freedesktop.org/archives/intel-gfx>
List-Post: <mailto:intel-gfx@lists.freedesktop.org>
List-Help: <mailto:intel-gfx-request@lists.freedesktop.org?subject=help>
List-Subscribe: <http://lists.freedesktop.org/mailman/listinfo/intel-gfx>,
 <mailto:intel-gfx-request@lists.freedesktop.org?subject=subscribe>
Errors-To: intel-gfx-bounces@lists.freedesktop.org
Sender: "Intel-gfx" <intel-gfx-bounces@lists.freedesktop.org>
To: "Mateo Lozano, Oscar" <oscar.mateo@intel.com>
Cc: "intel-gfx@lists.freedesktop.org" <intel-gfx@lists.freedesktop.org>
List-Id: intel-gfx@lists.freedesktop.org

On Thu, Jul 03, 2014 at 03:38:34PM +0000, Mateo Lozano, Oscar wrote:
> > -----Original Message-----
> > From: Intel-gfx [mailto:intel-gfx-bounces@lists.freedesktop.org] On Beh=
alf
> > Of oscar.mateo@intel.com
> > Sent: Thursday, July 03, 2014 4:28 PM
> > To: intel-gfx@lists.freedesktop.org
> > Subject: [Intel-gfx] [PATCH 4/8] drm/i915: Add kerneldoc comments to the
> > intel_context struct
> > =

> > From: Oscar Mateo <oscar.mateo@intel.com>
> > =

> > A bit of background on the context elements.
> > =

> > Cc: Jesse Barnes <jbarnes@virtuousgeek.org>
> > Signed-off-by: Oscar Mateo <oscar.mateo@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.rsvd=
1. */
> > #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 defa=
ult
> > 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=B4t 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