From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by dpdk.org (Postfix) with ESMTP id DA5C44C93 for ; Fri, 7 Sep 2018 18:31:47 +0200 (CEST) X-Amp-Result: UNSCANNABLE X-Amp-File-Uploaded: False Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 07 Sep 2018 09:31:43 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.53,343,1531810800"; d="scan'208";a="71432854" Received: from bricha3-mobl.ger.corp.intel.com ([10.252.5.248]) by orsmga008.jf.intel.com with SMTP; 07 Sep 2018 09:31:41 -0700 Received: by (sSMTP sendmail emulation); Fri, 07 Sep 2018 17:31:40 +0100 Date: Fri, 7 Sep 2018 17:31:39 +0100 From: Bruce Richardson To: Luca Boccassi Cc: dev@dpdk.org, john.mcnamara@intel.com, marko.kovacevic@intel.com, thomas@monjalon.net Message-ID: <20180907163139.GB24984@bricha3-MOBL.ger.corp.intel.com> References: <20180831182055.30772-1-bluca@debian.org> <20180831182055.30772-5-bluca@debian.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20180831182055.30772-5-bluca@debian.org> Organization: Intel Research and Development Ireland Ltd. User-Agent: Mutt/1.10.1 (2018-07-13) Subject: Re: [dpdk-dev] [PATCH 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 07 Sep 2018 16:31:48 -0000 On Fri, Aug 31, 2018 at 07:20:55PM +0100, Luca Boccassi wrote: > Both a configuration-time "enable_docs" boolean option and an optional > 'ninja doc' target are available. Note that due to a Meson bug for now > the latter will only build, but not install the files. > > Signed-off-by: Luca Boccassi > --- > doc/api/generate_doxygen.sh | 10 ++++++++ > doc/api/meson.build | 51 +++++++++++++++++++++++++++++++++++++ > doc/build-sdk-meson.txt | 2 ++ > doc/meson.build | 4 +++ > meson.build | 3 +++ > meson_options.txt | 2 ++ > 6 files changed, 72 insertions(+) > create mode 100755 doc/api/generate_doxygen.sh > create mode 100644 doc/api/meson.build > create mode 100644 doc/meson.build > > 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 > + > +DOXYCONF=$1 > +OUTDIR=$2 > +SCRIPTCSS=$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..e44963e4a9 > --- /dev/null > +++ b/doc/api/meson.build > @@ -0,0 +1,51 @@ > +# SPDX-License-Identifier: BSD-3-Clause > +# Copyright(c) 2018 Luca Boccassi > + > +# 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 = find_program('generate_doxygen.sh') > +generate_examples = find_program('generate_examples.sh') > +generate_css = find_program('doxy-html-custom.sh') > +doxygen = find_program('doxygen') This needs to be inside a conditional if we are not building docs. Otherwise overall build will error out if doxygen is missing - even if unused. /Bruce