diff options
author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2018-12-13 13:43:54 +0100 |
---|---|---|
committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2018-12-13 16:46:35 +0100 |
commit | ef0efddfca483ce545b86880eb41221a99e63d60 (patch) | |
tree | d0202a31c3c423ce95145309de98ec5d7866742a /README.md | |
parent | 2c793666d8c8328733f5769b16ae5858fee97f3f (diff) |
README: Use meson for building docs
Also simplify the instructions for meson 0.47+, where we track
dependencies correctly.
v2: Fix typo (Petri)
Reviewed-by: Petri Latvala <petri.latvala@intel.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 11 |
1 files changed, 8 insertions, 3 deletions
@@ -126,7 +126,7 @@ to generate this API documentation. To regenerate the html files when updating documentation, use: - $ make clean -C docs && make -C docs + $ ninja -C build igt-gpu-tools-doc If you've added/changed/removed a symbol or anything else that changes the overall structure or indexes, this needs to be reflected in @@ -188,14 +188,19 @@ Note that meson insist on separate build directories from the source tree. Running selfchecks for lib/tests and tests/ is done with - $ cd build && ninja test + $ ninja -C build test Note that this doesn't actually run the testcases in tests/: scripts/run-tests.sh should continue to be used for that. Documentation is built using - $ cd build && ninja && ninja igt-gpu-tools-doc + $ ninja -C build igt-gpu-tools-doc + +Note that this needs meson v0.47 or later, earlier versions of meson do not +track depencies correctly for the documentation build and need: + + $ ninja -C build && ninja -C build igt-gpu-tools-doc Note that there's a setup script similar to ./autogen.sh which creates a compatibility Makefile with a few useful default targets: |