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>
This commit is contained in:
Daniel Vetter 2014-03-26 15:15:49 +01:00
parent 64401f57e9
commit c6c2b2bb70
6 changed files with 25 additions and 3 deletions

2
NEWS
View File

@ -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).

View File

@ -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"/>

View File

@ -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

View File

@ -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 }

View File

@ -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)
{

View File

@ -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.
*/
/**