summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Vetter <daniel.vetter@ffwll.ch>2014-03-11 21:03:39 +0100
committerDaniel Vetter <daniel.vetter@ffwll.ch>2014-03-11 21:03:39 +0100
commita90846adf52127afe6dd3537c047b93c31cb313f (patch)
treec6c6c61d778d2dcb8cf2e7afd8818fe31aa5e365
parent2d4438605efd57a7ed336df42326693065ee5d02 (diff)
gtk-doc: Document the docs
- configure output to easily see whether docs are built or not - small blurb in README Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
-rw-r--r--README6
-rw-r--r--configure.ac2
2 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
index 79653f5c..66462c8a 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 2c991a85..2ddbe0dd 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 :