flywithu/ntel-gpu-tools
1
0
Fork 0
mirror of https://github.com/tiagovignatti/intel-gpu-tools.git synced 2025-06-22 07:16:14 +00:00
Code Issues Releases Wiki Activity

README: update the section on modifying and rebuilding documentation

Browse Source 
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
This commit is contained in:
Thomas Wood 2014-06-09 14:05:42 +01:00
parent 1e5c8780d0
commit 3dd7ad14d3
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README
View File

@ -108,16 +108,14 @@ docs/
reference documenation in docs/reference/ You need to have the gtk doc reference documenation in docs/reference/ You need to have the gtk doc
tools installed to generate this API documentation. tools installed to generate this API documentation.
Note that the currrent gtk-docs integration sucks a bit wrt regenerating To regenerate the html files when updating documentation, use:
the html files. You need at least
$ make clean -C docs && make -C docs $ make clean -C docs && make -C docs
to regenerate them on any change. If you've added/changed/removed a If you've added/changed/removed a symbol or anything else that changes
symbol or anything else that changes the overall structure or indexes, the overall structure or indexes, this needs to be reflected in
you need a full rebuild: intel-gpu-tools-sections.txt. Entirely new sections will also need to be
added to intel-gpu-tools-docs.xml in the appropriate place.
$ git clean -dfx && ./autogen.sh --enable-gtk-doc && make -C docs
DEPENDENCIES DEPENDENCIES
This is a non-exchaustive list of package dependencies required for This is a non-exchaustive list of package dependencies required for