docs: minimal docs for igt_vgem.c

Feeling somewhat lazy right now ;-)

Cc: Chris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>

1 files changed, 12 insertions, 0 deletions

diff --git a/lib/igt_vgem.c b/lib/igt_vgem.c
index 81c5a3b7..21cccb37 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;