diff options
| author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2014-03-25 17:46:32 +0100 |
|---|---|---|
| committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2014-03-25 17:46:32 +0100 |
| commit | c8190147526000bc002c611bd3612caf2de22bf8 (patch) | |
| tree | c6826598d7282a2253d302ddd038b47e4a5e4d2c /README | |
| parent | 05f6a35d40a9374ea560c88c2b12a715eb404261 (diff) | |
README: document quirks for regenerating gtk-doc
It sucks a bit atm :(
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Diffstat (limited to 'README')
| -rw-r--r-- | README | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -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: |