From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <luca.boccassi@gmail.com>
Received: from mail-wm0-f66.google.com (mail-wm0-f66.google.com [74.125.82.66])
by dpdk.org (Postfix) with ESMTP id 3C32E4C93
for <dev@dpdk.org>; Mon, 10 Sep 2018 18:15:28 +0200 (CEST)
Received: by mail-wm0-f66.google.com with SMTP id t25-v6so22027991wmi.3
for <dev@dpdk.org>; Mon, 10 Sep 2018 09:15:28 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20161025;
h=x-gm-message-state:message-id:subject:from:to:cc:date:in-reply-to
:references:content-transfer-encoding:mime-version;
bh=fuBwmPkXK7lkVNq0t35KRUioQbHjxAGm84H57hITWL4=;
b=OSQWLNcdircZcIcfa/yD6IEHTWozEd+ir3ToR7Qf6tTDJEehL+JK7asFDYlbQPnTY5
nFcMx/xduco7slWKQ1Duvu1Att0m9WAG5hDBEpO3ftJ0bE7p8zXCaEIM2agNF83vSd6b
yBoR3yAEw7rMXEj9jd8l8YMTlOLoMLJTSrjIaEABz/EuzbkaumrT0O/xxXBq/EV4lODQ
rzFLE07ibdXdedvXyf0i2DRWenELd7eKUBCGPmKRcsNjkgOD8fB+/rTCPCOjcI109/qc
DIWarpb9Wfb7wSjNu+L8nLHKzaIz9Q4VlXnjH1wHe6E70Egq7JaeoC+UiqCuNN4rfmxG
gwzA==
X-Gm-Message-State: APzg51BvC4Gm22H304Q2XHLr36htfGfbu8E2C1Xo2Xn5zqsetNibpLF4
whV1HT4BPM+NpWOhWoskmYY=
X-Google-Smtp-Source: ANB0VdbzlYz7gxr653srzJ5V6U6XT/B5krM2DJ9IWkdmBMtDPoelia1aI7r7M9pcUc9v5Jw0nP9wxA==
X-Received: by 2002:a1c:87ca:: with SMTP id
j193-v6mr1300712wmd.76.1536596127860;
Mon, 10 Sep 2018 09:15:27 -0700 (PDT)
Received: from localhost ([2a01:4b00:f419:6f00:8361:8946:ba2b:d556])
by smtp.gmail.com with ESMTPSA id s2-v6sm20216605wrn.83.2018.09.10.09.15.26
(version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256);
Mon, 10 Sep 2018 09:15:26 -0700 (PDT)
Message-ID: <1536596126.10952.4.camel@debian.org>
From: Luca Boccassi <bluca@debian.org>
To: Bruce Richardson <bruce.richardson@intel.com>
Cc: dev@dpdk.org, john.mcnamara@intel.com, marko.kovacevic@intel.com,
thomas@monjalon.net
Date: Mon, 10 Sep 2018 17:15:26 +0100
In-Reply-To: <20180910154705.GA24552@bricha3-MOBL.ger.corp.intel.com>
References: <20180831182055.30772-1-bluca@debian.org>
<20180907165524.23982-1-bluca@debian.org>
<20180907165524.23982-4-bluca@debian.org>
<20180910154705.GA24552@bricha3-MOBL.ger.corp.intel.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
X-Mailer: Evolution 3.22.6-1+deb9u1
Mime-Version: 1.0
Subject: Re: [dpdk-dev] [PATCH v2 4/4] build: generate API documentation
with Meson
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 10 Sep 2018 16:15:28 -0000
On Mon, 2018-09-10 at 16:47 +0100, Bruce Richardson wrote:
> On Fri, Sep 07, 2018 at 05:55:24PM +0100, Luca Boccassi wrote:
> > Signed-off-by: Luca Boccassi <bluca@debian.org>
> > ---
> > v2: made doxygen dependency optional, skip doxygen build when not
> > found
> >=20
> > =C2=A0doc/api/generate_doxygen.sh | 10 +++++++
> > =C2=A0doc/api/meson.build=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=
=A0=C2=A0| 54
> > +++++++++++++++++++++++++++++++++++++
> > =C2=A0doc/build-sdk-meson.txt=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0|=C2=A0=C2=
=A02 ++
> > =C2=A0doc/meson.build=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0|=C2=A0=C2=A04 +++
> > =C2=A0meson.build=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0|=C2=A0=C2=A03 +++
> > =C2=A0meson_options.txt=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0|=C2=A0=C2=A02 ++
> > =C2=A06 files changed, 75 insertions(+)
> > =C2=A0create mode 100755 doc/api/generate_doxygen.sh
> > =C2=A0create mode 100644 doc/api/meson.build
> > =C2=A0create mode 100644 doc/meson.build
> >=20
> > diff --git a/doc/api/generate_doxygen.sh
> > b/doc/api/generate_doxygen.sh
> > new file mode 100755
> > index 0000000000..ab57660958
> > --- /dev/null
> > +++ b/doc/api/generate_doxygen.sh
> > @@ -0,0 +1,10 @@
> > +#! /bin/sh -e
> > +# SPDX-License-Identifier: BSD-3-Clause
> > +# Copyright 2018 Luca Boccassi <bluca@debian.org>
> > +
> > +DOXYCONF=3D$1
> > +OUTDIR=3D$2
> > +SCRIPTCSS=3D$3
> > +
> > +doxygen "${DOXYCONF}"
> > +"${SCRIPTCSS}" "${OUTDIR}"/doxygen.css
> > diff --git a/doc/api/meson.build b/doc/api/meson.build
> > new file mode 100644
> > index 0000000000..5dfa0fe044
> > --- /dev/null
> > +++ b/doc/api/meson.build
> > @@ -0,0 +1,54 @@
> > +# SPDX-License-Identifier: BSD-3-Clause
> > +# Copyright(c) 2018 Luca Boccassi <bluca@debian.org>
> > +
> > +doxygen =3D find_program('doxygen', required: false)
>=20
> Thinking about it, I think that "required" should be set to
> "get_option(enable_docs)", since if someone explicitly enables the
> docs
> they should be built and cause error if they can't be.
Done in v3
> > +
> > +if doxygen.found()
> > + # due to the CSS customisation script, which needs to run
> > on a file that
> > + # is in a subdirectory that is created at build time and
> > thus it cannot
> > + # be an individual custom_target, we need to wrap the
> > doxygen call in a
> > + # script to run the CSS modification afterwards
> > + generate_doxygen =3D find_program('generate_doxygen.sh')
> > + generate_examples =3D find_program('generate_examples.sh')
> > + generate_css =3D find_program('doxy-html-custom.sh')
> > +
> > + inputdir =3D join_paths(meson.source_root(), 'examples')
> > + htmldir =3D join_paths('doc', 'html')
> > +
> > + # due to the following bug: https://github.com/mesonbuild/
> > meson/issues/4107
> > + # if install is set to true it will override
> > build_by_default and it will
> > + # cause the target to always be built. If install were to
> > be always set to
> > + # false it would be impossible to install the docs.
> > + # So use a configure option for now.
> > + example =3D custom_target('examples.dox',
> > + input: inputdir,
> > + output: 'examples.dox',
> > + command: [generate_examples, '@INPUT@', '@OUTPUT@'
> > ],
> > + install: get_option('enable_docs'),
> > + install_dir: htmldir,
> > + build_by_default: false)
> > +
> > + cdata =3D configuration_data()
> > + cdata.set('VERSION', meson.project_version())
> > + cdata.set('API_EXAMPLES', join_paths(meson.build_root(),
> > 'doc', 'api', 'examples.dox'))
> > + cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc',
> > 'api'))
> > + cdata.set('HTML_OUTPUT', 'api')
> > + cdata.set('TOPDIR', meson.source_root())
> > + cdata.set('STRIP_FROM_PATH', meson.source_root())
> > +
> > + doxy_conf =3D configure_file(input: 'doxy-api.conf.in',
> > + output: 'doxy-api.conf',
> > + configuration: cdata,
> > + install: false)
> > +
> > + doxy_build =3D custom_target('doxygen',
> > + depends: example,
> > + input: doxy_conf,
> > + output: 'api',
> > + command: [generate_doxygen, '@INPUT@', '@OUTPUT@',
> > generate_css],
> > + install: get_option('enable_docs'),
> > + install_dir: htmldir,
> > + build_by_default: false)
> > +
> > + run_target('doc', command: 'true', depends: doxy_build)
> > +endif
>=20
> Suggestion: add a run_target in an else leg to just print out "no
> doxygen found" or similar message when ninja doc is called.
Done
--=20
Kind regards,
Luca Boccassi