diff options
| author | Thomas Wood <thomas.wood@intel.com> | 2014-06-09 14:05:42 +0100 |
|---|---|---|
| committer | Thomas Wood <thomas.wood@intel.com> | 2014-06-12 10:12:13 +0100 |
| commit | 3dd7ad14d3322a727365745e94cbe46975acc423 (patch) | |
| tree | 988d11dc58f6e5c1b1cd91bef5d869984333a5c2 /README | |
| parent | 1e5c8780d03f78c17963108896354296f7313c61 (diff) | |
README: update the section on modifying and rebuilding documentation
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
Diffstat (limited to 'README')
| -rw-r--r-- | README | 12 |
1 files changed, 5 insertions, 7 deletions
@@ -108,16 +108,14 @@ 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 + To regenerate the html files when updating documentation, use: $ 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 + If you've added/changed/removed a symbol or anything else that changes + the overall structure or indexes, this needs to be reflected in + intel-gpu-tools-sections.txt. Entirely new sections will also need to be + added to intel-gpu-tools-docs.xml in the appropriate place. DEPENDENCIES This is a non-exchaustive list of package dependencies required for |