README: document quirks for regenerating gtk-doc

It sucks a bit atm :(

Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
This commit is contained in:
Daniel Vetter 2014-03-25 17:46:32 +01:00
parent 05f6a35d40
commit c819014752

11
README
View File

@ -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: