From c8190147526000bc002c611bd3612caf2de22bf8 Mon Sep 17 00:00:00 2001 From: Daniel Vetter Date: Tue, 25 Mar 2014 17:46:32 +0100 Subject: [PATCH] README: document quirks for regenerating gtk-doc It sucks a bit atm :( Signed-off-by: Daniel Vetter --- README | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README b/README index 66462c8..7ae9bb2 100644 --- a/README +++ b/README @@ -115,6 +115,17 @@ docs/ reference documenation in docs/reference/ You need to have the gtk doc tools installed to generate this API documentation. + Note that the currrent gtk-docs integration sucks a bit wrt regenerating + the html files. You need at least + + $ make clean -C docs && make -C docs + + to regenerate them on any change. If you've added/changed/removed a + symbol or anything else that changes the overall structure or indexes, + you need a full rebuild: + + $ git clean -dfx && ./autogen.sh --enable-gtk-doc && make -C docs + DEPENDENCIES This is a non-exchaustive list of package dependencies required for building everything: -- 2.7.4