From mboxrd@z Thu Jan  1 00:00:00 1970
From: Daniel Vetter <daniel@ffwll.ch>
Subject: Re: [PATCH v2] drm: Fix drm_rect documentation
Date: Wed, 8 May 2013 16:42:51 +0200
Message-ID: <20130508144251.GT5763@phenom.ffwll.local>
References: <20130508135519.GR5763@phenom.ffwll.local>
	<1368022605-9753-1-git-send-email-ville.syrjala@linux.intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Return-path: <intel-gfx-bounces+gcfxdi-intel-gfx=m.gmane.org@lists.freedesktop.org>
Received: from mail-ea0-f181.google.com (mail-ea0-f181.google.com
	[209.85.215.181])
	by gabe.freedesktop.org (Postfix) with ESMTP id 3A702E6349
	for <intel-gfx@lists.freedesktop.org>;
	Wed,  8 May 2013 07:39:45 -0700 (PDT)
Received: by mail-ea0-f181.google.com with SMTP id a15so965131eae.26
	for <intel-gfx@lists.freedesktop.org>;
	Wed, 08 May 2013 07:39:44 -0700 (PDT)
Content-Disposition: inline
In-Reply-To: <1368022605-9753-1-git-send-email-ville.syrjala@linux.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>
Sender: intel-gfx-bounces+gcfxdi-intel-gfx=m.gmane.org@lists.freedesktop.org
Errors-To: intel-gfx-bounces+gcfxdi-intel-gfx=m.gmane.org@lists.freedesktop.org
To: ville.syrjala@linux.intel.com
Cc: intel-gfx@lists.freedesktop.org, Laurent Pinchart <laurent.pinchart@ideasonboard.com>, dri-devel@lists.freedesktop.org
List-Id: intel-gfx@lists.freedesktop.org

On Wed, May 08, 2013 at 05:16:45PM +0300, ville.syrjala@linux.intel.com wro=
te:
> From: Ville Syrj=E4l=E4 <ville.syrjala@linux.intel.com>
> =

> The 'struct' keyword was missing so struct drm_rect documentation never
> ended up in the generated docs.
> =

> Also move the drm_rect documentations to a new section alognside the
> various helper functions and add a short description about the intended
> purpose of drm_rect.
> =

> v2: Move to new section and add general description
> =

> Signed-off-by: Ville Syrj=E4l=E4 <ville.syrjala@linux.intel.com>

Looks neat! Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
>  Documentation/DocBook/drm.tmpl | 8 ++++++--
>  include/drm/drm_rect.h         | 9 ++++++++-
>  2 files changed, 14 insertions(+), 3 deletions(-)
> =

> diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.t=
mpl
> index 7c7af25..91ee107 100644
> --- a/Documentation/DocBook/drm.tmpl
> +++ b/Documentation/DocBook/drm.tmpl
> @@ -1653,8 +1653,6 @@ void intel_crt_init(struct drm_device *dev)
>      <sect2>
>        <title>KMS API Functions</title>
>  !Edrivers/gpu/drm/drm_crtc.c
> -!Edrivers/gpu/drm/drm_rect.c
> -!Finclude/drm/drm_rect.h
>      </sect2>
>    </sect1>
>  =

> @@ -2163,6 +2161,12 @@ void intel_crt_init(struct drm_device *dev)
>        <title>EDID Helper Functions Reference</title>
>  !Edrivers/gpu/drm/drm_edid.c
>      </sect2>
> +    <sect2>
> +      <title>Rectangle Utilities Reference</title>
> +!Pinclude/drm/drm_rect.h rect utils
> +!Iinclude/drm/drm_rect.h
> +!Edrivers/gpu/drm/drm_rect.c
> +    </sect2>
>    </sect1>
>  =

>    <!-- Internals: vertical blanking -->
> diff --git a/include/drm/drm_rect.h b/include/drm/drm_rect.h
> index 64fa265..d128629 100644
> --- a/include/drm/drm_rect.h
> +++ b/include/drm/drm_rect.h
> @@ -25,7 +25,14 @@
>  #define DRM_RECT_H
>  =

>  /**
> - * drm_rect - two dimensional rectangle
> + * DOC: rect utils
> + *
> + * Utility functions to help manage rectangular areas for
> + * clipping, scaling, etc. calculations.
> + */
> +
> +/**
> + * struct drm_rect - two dimensional rectangle
>   * @x1: horizontal starting coordinate (inclusive)
>   * @x2: horizontal ending coordinate (exclusive)
>   * @y1: vertical starting coordinate (inclusive)
> -- =

> 1.8.1.5
> =


-- =

Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch