[Intel-gfx] [PATCH] gtk-doc: Document the docs

Daniel Vetter daniel.vetter at ffwll.ch
Tue Mar 11 21:04:38 CET 2014


- configure output to easily see whether docs are built or not
- small blurb in README

Signed-off-by: Daniel Vetter <daniel.vetter at ffwll.ch>
---
 README       | 6 ++++++
 configure.ac | 2 ++
 2 files changed, 8 insertions(+)

diff --git a/README b/README
index 79653f5cb27f..66462c8a9bda 100644
--- a/README
+++ b/README
@@ -110,6 +110,11 @@ debugger/
 
 	The debugger must be run as root: "sudo debugger/eudb"
 
+docs/
+	Thus far just contains the autogenerated intel-gpu-tools libraries
+	reference documenation in docs/reference/ You need to have the gtk doc
+	tools installed to generate this API documentation.
+
 DEPENDENCIES
 	This is a non-exchaustive list of package dependencies required for
 	building everything:
@@ -121,3 +126,4 @@ DEPENDENCIES
 	swig2.0
 	libpython3.3-dev
 	x11proto-dri2-dev
+	gtk-doc-tools
diff --git a/configure.ac b/configure.ac
index 2c991a8502f7..2ddbe0dd06f5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -235,5 +235,7 @@ echo "       Debugger           : ${enable_debugger}"
 echo "       Python dumper      : ${DUMPER}"
 echo "       Overlay            : X: ${enable_overlay_xlib}, Xv: ${enable_overlay_xvlib}"
 echo ""
+echo " • API-Documentation      : ${enable_gtk_doc}"
+echo ""
 
 # vim: set ft=config ts=8 sw=8 tw=0 noet :
-- 
1.8.5.2




More information about the Intel-gfx mailing list