From patchwork Wed Mar 26 16:15:52 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 3894261 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id BCB07BF549 for ; Wed, 26 Mar 2014 16:16:31 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id CEEAF2022A for ; Wed, 26 Mar 2014 16:16:30 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id 553A62021F for ; Wed, 26 Mar 2014 16:16:29 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id E01BD6E6C6; Wed, 26 Mar 2014 09:16:28 -0700 (PDT) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-ee0-f41.google.com (mail-ee0-f41.google.com [74.125.83.41]) by gabe.freedesktop.org (Postfix) with ESMTP id E9DE16E6B2 for ; Wed, 26 Mar 2014 09:16:26 -0700 (PDT) Received: by mail-ee0-f41.google.com with SMTP id t10so1854814eei.14 for ; Wed, 26 Mar 2014 09:16:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ffwll.ch; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=U3XulwWi/7n2Ot8Plw98au3P4iQ5QpAiUsCTIUcEfp8=; b=CWeAXIBqIIV12pFgE9ErDgZrwJZQVPllxFS3B9BscqQXLXOGpEA6yDtJBQHBgY5VlC B4U4qeqhto5KdWWcD6cMKFqTAEXe/Um4++GK0hgMbWBPPLqk4hnQTtt1942J0lc2mtu7 IMft1mB+aoNZ/U85QcOl76Xpy7j6Q8xugXjkk= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=U3XulwWi/7n2Ot8Plw98au3P4iQ5QpAiUsCTIUcEfp8=; b=XI+T3mP3VU21M98VXQjr+mpUQ5WBemOYnKtke+9kQXkTlVgLcmoJTIPtWwvCo/2fjb 55ukkvRLn9sbd9nTVieOtHgQ9kTIbQ2CYnKy0XrP0mfvVZuKZKEOWLjKF97QGmHrH1qG i5pfZmOpDvjUqzu+ompKisAQ5LZitLubuvvt3COEHgqS5evrE54uz3tv4y5jQ3ASGmw6 99Itdjq851lf57fJU6RCu1QTAS3zdMHT1P7kBJVXOVlxI2DIoqFxK4LYFdZq6vDW1JkY arkoVenyztQcqAc0xqnpdXo7fsy38G1+y1rI3DSk4SekkzIm1/HgOXCDPx7Rc7S3UQ5D UjOg== X-Gm-Message-State: ALoCoQlgK1C8sARweaqSCb2tAQUPhIbX24Ffo4heZzGWPAQhQKI7LaOXLCO4weyWcr97qTOkTQre X-Received: by 10.14.100.69 with SMTP id y45mr821031eef.108.1395850586185; Wed, 26 Mar 2014 09:16:26 -0700 (PDT) Received: from phenom.ffwll.local (84-73-67-144.dclient.hispeed.ch. [84.73.67.144]) by mx.google.com with ESMTPSA id l42sm48041287eew.19.2014.03.26.09.16.24 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 26 Mar 2014 09:16:25 -0700 (PDT) From: Daniel Vetter To: Intel Graphics Development Date: Wed, 26 Mar 2014 17:15:52 +0100 Message-Id: <1395850555-17948-9-git-send-email-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 1.8.5.2 In-Reply-To: <1395850555-17948-1-git-send-email-daniel.vetter@ffwll.ch> References: <1395850555-17948-1-git-send-email-daniel.vetter@ffwll.ch> Cc: Daniel Vetter Subject: [Intel-gfx] [PATCH 09/12] lib/igt_kms/bf: doc skeleton X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.15 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.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_MED,RP_MATCHES_RCVD,T_DKIM_INVALID,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 igt_kms docs are just skeleton and also added igt_fb to make sure the linking works correctly. Next up: Actually documenting igt_fb. Also fix that depency spelling fumble I've copied around to a few too many places. Signed-off-by: Daniel Vetter --- NEWS | 2 +- docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml | 1 + lib/drmtest.c | 2 +- lib/igt_fb.c | 7 +++++++ lib/igt_kms.c | 14 ++++++++++++++ lib/intel_batchbuffer.c | 2 +- 6 files changed, 25 insertions(+), 3 deletions(-) diff --git a/NEWS b/NEWS index fa4adb753e6b..52036e1d4c78 100644 --- a/NEWS +++ b/NEWS @@ -15,7 +15,7 @@ Release 1.6 (2014-03-13) http://blog.ffwll.ch/2013/11/testing-requirements-for-drmi915.html -- Fix the gen4asm build depency handling, now that the assembler is included in +- Fix the gen4asm build dependency handling, now that the assembler is included in i-g-t (Ben). - Improve the cairo object lifetime management of the kmstest helpers (Chris). 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 1dafe6c2a7dc..dcfff33c9dfc 100644 --- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml +++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml @@ -19,6 +19,7 @@ + diff --git a/lib/drmtest.c b/lib/drmtest.c index d48af9c81cad..b1bf5892a596 100644 --- a/lib/drmtest.c +++ b/lib/drmtest.c @@ -70,7 +70,7 @@ * But there's also a bit of other assorted stuff here. * * Note that this library's header pulls in the [i-g-t core](intel-gpu-tools-i-g-t-core.html) - * and [batchbuffer](intel-gpu-tools-intel-batchbuffer.html) libraries as depencies. + * and [batchbuffer](intel-gpu-tools-intel-batchbuffer.html) libraries as dependencies. */ static int diff --git a/lib/igt_fb.c b/lib/igt_fb.c index 9cbfe6465ecd..5e7c78908152 100644 --- a/lib/igt_fb.c +++ b/lib/igt_fb.c @@ -33,6 +33,13 @@ #include "igt_fb.h" #include "ioctl_wrappers.h" +/** + * SECTION:igt_fb + * @short_description: Framebuffer handling and drawing library + * @title: i-g-t framebuffer + * @include: igt_fb.h + */ + /* drm fourcc/cairo format maps */ #define DF(did, cid, _bpp, _depth) \ { DRM_FORMAT_##did, CAIRO_FORMAT_##cid, # did, _bpp, _depth } diff --git a/lib/igt_kms.c b/lib/igt_kms.c index 678cf391234c..9dee855c8053 100644 --- a/lib/igt_kms.c +++ b/lib/igt_kms.c @@ -42,6 +42,20 @@ #include "igt_kms.h" #include "igt_aux.h" +/** + * SECTION:igt_kms + * @short_description: Kernel modesetting support library + * @title: i-g-t kms + * @include: igt_kms.h + * + * This library provides support to enumerate and set modeset configurations. + * + * Since this library is very much still a work-in-progress and the interfaces + * still in-flux detailed api documentation is currently still missing. + * + * Note that this library's header pulls in the [i-g-t framebuffer](intel-gpu-tools-i-g-t-framebuffer.html) + * library as a dependency. + */ const char *kmstest_pipe_str(int pipe) { diff --git a/lib/intel_batchbuffer.c b/lib/intel_batchbuffer.c index 0d583c73aa51..e8689228cea7 100644 --- a/lib/intel_batchbuffer.c +++ b/lib/intel_batchbuffer.c @@ -58,7 +58,7 @@ * #OUT_BATCH, #OUT_RELOC and #ADVANCE_BATCH. * * Note that this library's header pulls in the [i-g-t core](intel-gpu-tools-i-g-t-core.html) - * library as a depency. + * library as a dependency. */ /**