diff mbox series

[v2] libtraceevent: add option to disable documentation

Message ID 20230930204017.2528627-1-giulio.benetti@benettiengineering.com (mailing list archive)
State Accepted
Commit 5b893850d20f8e4377dcdf66089d60e2559b4b26
Headers show
Series [v2] libtraceevent: add option to disable documentation | expand

Commit Message

Giulio Benetti Sept. 30, 2023, 8:40 p.m. UTC
On some Linux environment builder(i.e. Buildroot) host asciidoc is not
provided since by default all man/docs are not installed to target but
meson.build at the moment build ascii and html documentation and
requires asciidoc making the building to fail. So let's add doc option
set to true by default to let the user to override it and not produce
the documentation.

Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
---
V1->V2:
* improve commit log as suggested by Steve Rostedt
---
 meson.build       | 3 +++
 meson_options.txt | 2 ++
 2 files changed, 5 insertions(+)
diff mbox series

Patch

diff --git a/meson.build b/meson.build
index b61c873..9a18e02 100644
--- a/meson.build
+++ b/meson.build
@@ -45,6 +45,8 @@  if cunit_dep.found()
     subdir('utest')
 endif
 subdir('samples')
+
+if get_option('doc')
 subdir('Documentation')
 
 custom_target(
@@ -52,3 +54,4 @@  custom_target(
     output: 'docs',
     depends: [html, man],
     command: ['echo'])
+endif
diff --git a/meson_options.txt b/meson_options.txt
index b2294f6..9a40dad 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -16,3 +16,5 @@  option('man-bold-literal', type : 'boolean', value : false,
        description : 'enable bold literals')
 option('docbook-suppress-sp', type : 'boolean', value : false,
        description : 'docbook suppress sp')
+option('doc', type : 'boolean', value: true,
+       description : 'produce documentation')