gtk-doc: Document the docs
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 11 Mar 2014 20:03:39 +0000 (21:03 +0100)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 11 Mar 2014 20:03:39 +0000 (21:03 +0100)
- configure output to easily see whether docs are built or not
- small blurb in README

Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
README
configure.ac

diff --git a/README b/README
index 79653f5..66462c8 100644 (file)
--- 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
index 2c991a8..2ddbe0d 100644 (file)
@@ -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 :