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@xxxxxxxx> --- 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 @@ <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 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. */ /** -- 1.8.5.2 _______________________________________________ Intel-gfx mailing list Intel-gfx@xxxxxxxxxxxxxxxxxxxxx http://lists.freedesktop.org/mailman/listinfo/intel-gfx
