From patchwork Thu May 14 16:04:24 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Wood X-Patchwork-Id: 6407201 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 682299F32B for ; Thu, 14 May 2015 16:04:34 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 60E0C20437 for ; Thu, 14 May 2015 16:04:33 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id 37EA620461 for ; Thu, 14 May 2015 16:04:32 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id A149C6E269; Thu, 14 May 2015 09:04:31 -0700 (PDT) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-wi0-f178.google.com (mail-wi0-f178.google.com [209.85.212.178]) by gabe.freedesktop.org (Postfix) with ESMTP id 8461C6E269 for ; Thu, 14 May 2015 09:04:30 -0700 (PDT) Received: by wicnf17 with SMTP id nf17so100203915wic.1 for ; Thu, 14 May 2015 09:04:29 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:subject:date:message-id; bh=vFNzqIVXFQp3q2C8iRGcU4R8jJPCLm1xbLxZJGIdYGk=; b=iq0kPOxgFDNyDtvjXEsIfLm90qgu83KCD7KD6k+t0G/oE0XoRudrhOssry+DVwwPka sGn7TjUawduolCfWcsYPa4Mp8Xh9uShW7pPbe+2xlggakokfDAfvd79hSbJMqbisWyII hj5IWQfqODRczYRq0mBDnEfxTkiyw9+WIzhdTzEFCwYY997ZTwI8282x7poHZob/PB0B 3S2iTjXWjbrPZ315sV6aU/lizLs7IrUoXFx+hifhAFdmJoyg8/dJlbTs+6lkVhzZCFGK NAohPL0GiwslZj6pTPYQGKoYIiLqGiRSEDQRxEKR8mwBs/vVys5Imqbsm4ji0Ri14RFm D3FQ== X-Gm-Message-State: ALoCoQkJUftKDFZmipymYfe9pgoTlzWKXim5ds1b3Dl5ZmOPu2xfLzs50PWkaq2iLmM2pxfSgNi4 X-Received: by 10.181.11.193 with SMTP id ek1mr25463868wid.15.1431619469592; Thu, 14 May 2015 09:04:29 -0700 (PDT) Received: from pistachio.icx.intel.com ([83.217.123.106]) by mx.google.com with ESMTPSA id ew15sm13678613wjd.17.2015.05.14.09.04.28 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 14 May 2015 09:04:28 -0700 (PDT) From: Thomas Wood To: intel-gfx@lists.freedesktop.org Date: Thu, 14 May 2015 17:04:24 +0100 Message-Id: <1431619466-3914-1-git-send-email-thomas.wood@intel.com> X-Mailer: git-send-email 2.1.0 Subject: [Intel-gfx] [PATCH i-g-t 1/3] docs: various documentation fixes X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Fix various typos, add missing parameter documentation, include the igt_draw section and update the list of ignored headers. Signed-off-by: Thomas Wood --- docs/reference/intel-gpu-tools/Makefile.am | 3 ++- docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml | 1 + lib/igt_draw.c | 12 ++++++++++++ lib/igt_draw.h | 4 ++-- lib/igt_kms.c | 8 +++++--- 5 files changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/reference/intel-gpu-tools/Makefile.am b/docs/reference/intel-gpu-tools/Makefile.am index 8364247..0363014 100644 --- a/docs/reference/intel-gpu-tools/Makefile.am +++ b/docs/reference/intel-gpu-tools/Makefile.am @@ -126,7 +126,8 @@ EXTRA_HFILES= # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code IGNORE_HFILES=gen6_render.h gen7_media.h gen7_render.h gen8_media.h \ gen8_render.h i830_reg.h i915_3d.h i915_pciids.h i915_reg.h \ - intel_reg.h debug.h instdone.h media_fill.h rendercopy.h + intel_reg.h debug.h instdone.h media_fill.h rendercopy.h \ + media_spin.h media_fill_gen9.h gen9_render.h version.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml index 6c953fd..a6d1f89 100644 --- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml +++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml @@ -18,6 +18,7 @@ + diff --git a/lib/igt_draw.c b/lib/igt_draw.c index 14e470f..51dce4b 100644 --- a/lib/igt_draw.c +++ b/lib/igt_draw.c @@ -68,6 +68,7 @@ struct rect { /** * igt_draw_get_method_name: + * @method: draw method * * Simple function to transform the enum into a string. Useful when naming * subtests and printing debug messages. @@ -533,6 +534,17 @@ void igt_draw_rect(int fd, drm_intel_bufmgr *bufmgr, drm_intel_context *context, /** * igt_draw_rect_fb: + * @fd: the DRM file descriptor + * @bufmgr: the libdrm bufmgr, only required for IGT_DRAW_BLT and + * IGT_DRAW_RENDER + * @context: the context, can be NULL if you don't want to think about it + * @fb: framebuffer + * @method: method you're going to use to write to the buffer + * @rect_x: horizontal position on the buffer where your rectangle starts + * @rect_y: vertical position on the buffer where your rectangle starts + * @rect_w: width of the rectangle + * @rect_h: height of the rectangle + * @color: color of the rectangle * * This is exactly the same as igt_draw_rect, but you can pass an igt_fb instead * of manually providing its details. See igt_draw_rect. diff --git a/lib/igt_draw.h b/lib/igt_draw.h index 61ffad5..9d8413a 100644 --- a/lib/igt_draw.h +++ b/lib/igt_draw.h @@ -29,10 +29,10 @@ #include "igt_fb.h" /** - *igt_draw_method: + * igt_draw_method: * @IGT_DRAW_MMAP_CPU: draw using a CPU mmap. * @IGT_DRAW_MMAP_GTT: draw using a GTT mmap. - * @IGT-DRAW_MMAP_WC: draw using the WC mmap. + * @IGT_DRAW_MMAP_WC: draw using the WC mmap. * @IGT_DRAW_PWRITE: draw using the pwrite ioctl. * @IGT_DRAW_BLT: draw using the BLT ring. * @IGT_DRAW_RENDER: draw using the render ring. diff --git a/lib/igt_kms.c b/lib/igt_kms.c index 0665d70..f5670e0 100644 --- a/lib/igt_kms.c +++ b/lib/igt_kms.c @@ -1824,11 +1824,12 @@ void igt_plane_set_size(igt_plane_t *plane, int w, int h) /** * igt_fb_set_position: * @fb: framebuffer pointer + * @plane: plane * @x: X position * @y: Y position * * This function sets position for requested framebuffer as src to plane. - * New position will be commited at plane commit time via drmModeSetPlane(). + * New position will be committed at plane commit time via drmModeSetPlane(). */ void igt_fb_set_position(struct igt_fb *fb, igt_plane_t *plane, uint32_t x, uint32_t y) @@ -1846,13 +1847,14 @@ void igt_fb_set_position(struct igt_fb *fb, igt_plane_t *plane, } /** - * igt_fb_set_position: + * igt_fb_set_size: * @fb: framebuffer pointer + * @plane: plane * @w: width * @h: height * * This function sets fetch rect size from requested framebuffer as src - * to plane. New size will be commited at plane commit time via + * to plane. New size will be committed at plane commit time via * drmModeSetPlane(). */ void igt_fb_set_size(struct igt_fb *fb, igt_plane_t *plane,