diff mbox

[i-g-t,11/11] docs: minimal docs for igt_vgem.c

Message ID 1469623097-26044-12-git-send-email-daniel.vetter@ffwll.ch (mailing list archive)
State New, archived
Headers show

Commit Message

Daniel Vetter July 27, 2016, 12:38 p.m. UTC 
Feeling somewhat lazy right now ;-)

Cc: Chris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
---
 docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml |  1 +
 lib/igt_vgem.c                                          | 12 ++++++++++++
 2 files changed, 13 insertions(+)
diff mbox

Patch

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 fab806cdf42e..c862f2ad9580 100644
--- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
+++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
@@ -31,6 +31,7 @@ 
     <xi:include href="xml/intel_chipset.xml"/>
     <xi:include href="xml/intel_io.xml"/>
     <xi:include href="xml/igt_vc4.xml"/>
+    <xi:include href="xml/igt_vgem.xml"/>
   </chapter>
   <xi:include href="xml/igt_test_programs.xml"/>
 
diff --git a/lib/igt_vgem.c b/lib/igt_vgem.c
index 81c5a3b73ea8..21cccb375c51 100644
--- a/lib/igt_vgem.c
+++ b/lib/igt_vgem.c
@@ -28,6 +28,18 @@ 
 
 #include <sys/mman.h>
 
+/**
+ * SECTION:igt_vgem
+ * @short_description: VGEM support library
+ * @title: VGEM
+ * @include: igt.h
+ *
+ * This library provides various auxiliary helper functions for writing VGEM
+ * tests. VGEM is especially useful as a virtual dma-buf import and exporter and
+ * for testing cross driver synchronization (either using epxlicit dma-fences or
+ * using implicit fences attached to dma-bufs).
+ */
+
 int __vgem_create(int fd, struct vgem_bo *bo)
 {
 	struct drm_mode_create_dumb arg;