Re: [PATCH v1 1/1] Add support for meson building

From: Ariel D'Alessandro <ariel@vanguardiasur.com.ar>
To: Gregor Jasny <gjasny@googlemail.com>,
	Xavier Claessens <xavier.claessens@collabora.com>,
	Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
	Ezequiel Garcia <ezequiel@collabora.com>
Cc: kieran.bingham@ideasonboard.com, linux-media@vger.kernel.org,
	hverkuil@xs4all.nl, sean@mess.org, p.zabel@pengutronix.de,
	nicolas@ndufresne.ca,
	nicolas Dufresne <nicolas.dufresne@collabora.com>
Subject: Re: [PATCH v1 1/1] Add support for meson building
Date: Wed, 8 Jul 2020 02:48:37 -0300	[thread overview]
Message-ID: <0d9bd469-d23d-cef0-9e69-ea0b57e3f3b8@vanguardiasur.com.ar> (raw)
In-Reply-To: <6f598f9e-cb1b-2dd4-6a95-efe0895da0dc@googlemail.com>

Hey Gregor,

On 6/29/20 3:56 PM, Gregor Jasny wrote:
> Hello,
> 
> On 6/25/20 8:52 PM, Ariel D'Alessandro wrote:
>> The Doxygen m4 script provides several features, like:
>>
>>      $ git grep 'DX_ARG_ABLE(' m4/ax_prog_doxygen.m4
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(doc, [generate any doxygen
>> documentation],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(dot, [generate graphics for doxygen
>> documentation],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(man, [generate doxygen manual pages],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(rtf, [generate doxygen RTF
>> documentation],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(xml, [generate doxygen XML
>> documentation],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(chm, [generate doxygen compressed HTML
>> help documentation],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(chi, [generate doxygen seperate
>> compressed HTML help index file],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(html, [generate doxygen plain HTML
>> documentation],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(ps, [generate doxygen PostScript
>> documentation],
>>        m4/ax_prog_doxygen.m4:DX_ARG_ABLE(pdf, [generate doxygen PDF
>> documentation],
>>
>> I could port them all to meson and have options for each one. But, do we really
>> need all of them or just a subset?
>>
>> For instance, from [0]:
>>
>>      $ git grep CONFIGURE_FLAGS.*doxygen
>>        rules:CONFIGURE_FLAGS += --enable-doxygen-man --disable-doxygen-ps
>> --disable-doxygen-pdf
> 
> I think we need html (Debian) and man (Fedora).

I've pushed meson Doxygen support to:
    https://gitlab.com/adalessandro/v4l-utils/-/tree/v4l-utils-1.20.0-meson-v1

The following options were added, supporting html and man.

    # Doxygen options
    option('doxygen-doc', type : 'feature', value : 'auto',
           description : 'Generate doxygen project documentation')
    option('doxygen-html', type : 'boolean',
           description : 'Generate doxygen plain HTML documentation')
    option('doxygen-man', type : 'boolean', value : false,
           description : 'Generate doxygen manual pages')

So, you should get html and man documentation using:

    CONFIGURE_FLAGS += -Ddoxygen-doc=enabled -Ddoxygen-man=enabled

Note that documentation will be installed to:

    doxygen_install_dir = join_paths(get_option('datadir'), 'doc',
                                     '@0@-@1@'.format(meson.project_name(),
                                                      as_version))

Using default values, that'd be: /usr/local/share/doc/v4l-utils-1.20.0/

Hopefully, there will be a doxygen module for meson at some point in the future.

Anyway, let me know if you have any comments.

Regards,
Ariel