[PATCH v2] libtracefs: add option to disable documentation

[PATCH v2] libtracefs: add option to disable documentation

[Giulio Benetti]

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 --git a/meson.build b/meson.build
index 9d42d78..f1e492e 100644
--- a/meson.build
+++ b/meson.build
@@ -39,6 +39,8 @@ if cunit_dep.found()
     subdir('utest')
 endif
 subdir('samples')
+
+if get_option('doc')
 subdir('Documentation')
 
 custom_target(
@@ -46,3 +48,4 @@ custom_target(
     output: 'docs',
     depends: [html, man],
     command: ['echo'])
+endif
diff --git a/meson_options.txt b/meson_options.txt
index 1d92c28..5533a88 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -14,3 +14,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')
-- 
2.34.1

Re: [PATCH v2] libtracefs: add option to disable documentation

[Giulio Benetti]

Hi Steven,

would it be possible to commit this change before releasing new version?
This way I can add both libtracefs and libtraceevent without local
patches as you can see on this iteration to bump trace-cmd:
https://patchwork.ozlabs.org/project/buildroot/list/?series=379077

The same patch has been committed to libtraceevent:
https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/commit/?id=5b893850d20f8e4377dcdf66089d60e2559b4b26

Best regards
-- 
Giulio Benetti
CEO&CTO@Benetti Engineering sas

On 30/09/23 22:40, Giulio Benetti wrote:
> 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 --git a/meson.build b/meson.build
> index 9d42d78..f1e492e 100644
> --- a/meson.build
> +++ b/meson.build
> @@ -39,6 +39,8 @@ if cunit_dep.found()
>       subdir('utest')
>   endif
>   subdir('samples')
> +
> +if get_option('doc')
>   subdir('Documentation')
>   
>   custom_target(
> @@ -46,3 +48,4 @@ custom_target(
>       output: 'docs',
>       depends: [html, man],
>       command: ['echo'])
> +endif
> diff --git a/meson_options.txt b/meson_options.txt
> index 1d92c28..5533a88 100644
> --- a/meson_options.txt
> +++ b/meson_options.txt
> @@ -14,3 +14,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')

Re: [PATCH v2] libtracefs: add option to disable documentation

[Steven Rostedt]

On Sat, 6 Jan 2024 13:41:12 +0100
Giulio Benetti <giulio.benetti@benettiengineering.com> wrote:

> Hi Steven,
> 
> would it be possible to commit this change before releasing new version?
> This way I can add both libtracefs and libtraceevent without local
> patches as you can see on this iteration to bump trace-cmd:
> https://patchwork.ozlabs.org/project/buildroot/list/?series=379077
> 
> The same patch has been committed to libtraceevent:
> https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/commit/?id=5b893850d20f8e4377dcdf66089d60e2559b4b26
> 
> Best regards

Strange, patchwork had this as "Accepted", but it wasn't. Which would hide
it from me. :-/

Not sure how that happened. Thanks for letting me know. I'll add it now.

-- Steve