[PATCH] libtraceevent: add option to disable documentation

[PATCH] libtraceevent: add option to disable documentation

[Giulio Benetti]

Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
---
 meson.build       | 3 +++
 meson_options.txt | 2 ++
 2 files changed, 5 insertions(+)

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')
-- 
2.34.1

Re: [PATCH] libtraceevent: add option to disable documentation

[Steven Rostedt]

On Sat, 30 Sep 2023 22:13:39 +0200
Giulio Benetti <giulio.benetti@benettiengineering.com> wrote:

Hi Giulio,

Thanks for the patch, but could you please add a change log to explain
why this patch is needed? I'm not saying it isn't but I'd like to know
the rational for disabling documentation.

Thanks,

-- Steve


> Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
> ---
>  meson.build       | 3 +++
>  meson_options.txt | 2 ++
>  2 files changed, 5 insertions(+)
> 
> 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')

Re: [PATCH] libtraceevent: add option to disable documentation

[Giulio Benetti]

Hi Steve,

On 30/09/23 22:28, Steven Rostedt wrote:
> On Sat, 30 Sep 2023 22:13:39 +0200
> Giulio Benetti <giulio.benetti@benettiengineering.com> wrote:
> 
> Hi Giulio,
> 
> Thanks for the patch, but could you please add a change log to explain
> why this patch is needed? I'm not saying it isn't but I'd like to know
> the rational for disabling documentation.

Sure, same for libtracefs then.

Would it be possible to release a minor version after committing?
This is because I've updated libtraceevent, libtracefs and trace-cmd in
buildroot but without using meson due to asciidoc not found(in Buildroot
we never produce documentation for target).

So if you could release new versions of libtraceevent and libtracefs
after committing V2 patches I could bump in Buildroot and use meson
that is very clean compared to the actual Makefile custom build calls.

Going to send V2 patches in the meanwhile.

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

> Thanks,
> 
> -- Steve
> 
> 
>> Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
>> ---
>>   meson.build       | 3 +++
>>   meson_options.txt | 2 ++
>>   2 files changed, 5 insertions(+)
>>
>> 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')
> 

Re: [PATCH] libtraceevent: add option to disable documentation

[Steven Rostedt]

On Sat, 30 Sep 2023 22:32:52 +0200
Giulio Benetti <giulio.benetti@benettiengineering.com> wrote:

> Hi Steve,
> 
> On 30/09/23 22:28, Steven Rostedt wrote:
> > On Sat, 30 Sep 2023 22:13:39 +0200
> > Giulio Benetti <giulio.benetti@benettiengineering.com> wrote:
> > 
> > Hi Giulio,
> > 
> > Thanks for the patch, but could you please add a change log to explain
> > why this patch is needed? I'm not saying it isn't but I'd like to know
> > the rational for disabling documentation.  
> 
> Sure, same for libtracefs then.
> 
> Would it be possible to release a minor version after committing?
> This is because I've updated libtraceevent, libtracefs and trace-cmd in
> buildroot but without using meson due to asciidoc not found(in Buildroot
> we never produce documentation for target).

Sure, it's time for me to start working on the user space libraries
again anyway (I toggle my time between the kernel and user space
tracing).

> 
> So if you could release new versions of libtraceevent and libtracefs
> after committing V2 patches I could bump in Buildroot and use meson
> that is very clean compared to the actual Makefile custom build calls.
> 
> Going to send V2 patches in the meanwhile.
> 
> Best regards

Appreciated!

-- Steve

Re: [PATCH] libtraceevent: add option to disable documentation

[Giulio Benetti]

On 30/09/23 22:39, Steven Rostedt wrote:
> On Sat, 30 Sep 2023 22:32:52 +0200
> Giulio Benetti <giulio.benetti@benettiengineering.com> wrote:
> 
>> Hi Steve,
>>
>> On 30/09/23 22:28, Steven Rostedt wrote:
>>> On Sat, 30 Sep 2023 22:13:39 +0200
>>> Giulio Benetti <giulio.benetti@benettiengineering.com> wrote:
>>>
>>> Hi Giulio,
>>>
>>> Thanks for the patch, but could you please add a change log to explain
>>> why this patch is needed? I'm not saying it isn't but I'd like to know
>>> the rational for disabling documentation.
>>
>> Sure, same for libtracefs then.
>>
>> Would it be possible to release a minor version after committing?
>> This is because I've updated libtraceevent, libtracefs and trace-cmd in
>> buildroot but without using meson due to asciidoc not found(in Buildroot
>> we never produce documentation for target).
> 
> Sure, it's time for me to start working on the user space libraries
> again anyway (I toggle my time between the kernel and user space
> tracing).

Awesome!

>>
>> So if you could release new versions of libtraceevent and libtracefs
>> after committing V2 patches I could bump in Buildroot and use meson
>> that is very clean compared to the actual Makefile custom build calls.
>>
>> Going to send V2 patches in the meanwhile.
>>
>> Best regards
> 
> Appreciated!
> 
> -- Steve

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