lib/igt_kms/bf: doc skeleton

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 <daniel.vetter@ffwll.ch>

diff --git a/NEWS b/NEWS
index fa4adb7..52036e1 100644 (file)
--- 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 1dafe6c..dcfff33 100644 (file)
--- 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 @@
     <xi:include href="xml/igt_core.xml"/>
     <xi:include href="xml/igt_debugfs.xml"/>
     <xi:include href="xml/igt_kms.xml"/>
+    <xi:include href="xml/igt_fb.xml"/>
     <xi:include href="xml/igt_aux.xml"/>
     <xi:include href="xml/ioctl_wrappers.xml"/>
     <xi:include href="xml/intel_batchbuffer.xml"/>

diff --git a/lib/drmtest.c b/lib/drmtest.c
index d48af9c..b1bf589 100644 (file)
--- 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 9cbfe64..5e7c789 100644 (file)
--- 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 678cf39..9dee855 100644 (file)
--- 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 0d583c7..e868922 100644 (file)
--- 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.
  */
 
 /**