DPDK patches and discussions
 help / color / mirror / Atom feed
From: Luca Boccassi <bluca@debian.org>
To: dev@dpdk.org
Cc: bruce.richardson@intel.com, john.mcnamara@intel.com,
	marko.kovacevic@intel.com, thomas@monjalon.net
Subject: [dpdk-dev] [PATCH 0/4] Meson: build Doxygen documentation
Date: Fri, 31 Aug 2018 19:20:51 +0100
Message-ID: <20180831182055.30772-1-bluca@debian.org> (raw)

I have tested this by using diffoscope between the docs built by the
makefiles and by this Meson patchset, and verified they are all
identical.

There are both a new "doc" target (ninja doc) and a configuration
option. This is due to the following bug in Meson:
https://github.com/mesonbuild/meson/issues/4107
because of it it's not possible to have simply an optional target,
as its files will not be installed.
So by default the documentation is off, if one wants to just build it
'ninja doc' can be used, but if one wants to both build and install
the config option 'enable_docs' has to be enabled.

A couple of small refactoring was done to the makefile doc build, to
make things easier and doable by both build systems.

Luca Boccassi (4):
  mk: use script to generate examples.dox
  mk: use templated doxygen config, modified on the fly
  build: use same version as make showversion in Meson
  build: generate API documentation with Meson

 doc/api/doxy-api.conf        | 87 --------------------------------
 doc/api/doxy-api.conf.in     | 96 ++++++++++++++++++++++++++++++++++++
 doc/api/generate_doxygen.sh  | 10 ++++
 doc/api/generate_examples.sh | 14 ++++++
 doc/api/meson.build          | 51 +++++++++++++++++++
 doc/build-sdk-meson.txt      |  2 +
 doc/meson.build              |  4 ++
 meson.build                  |  5 +-
 meson_options.txt            |  2 +
 mk/rte.sdkdoc.mk             | 21 +++-----
 10 files changed, 191 insertions(+), 101 deletions(-)
 delete mode 100644 doc/api/doxy-api.conf
 create mode 100644 doc/api/doxy-api.conf.in
 create mode 100755 doc/api/generate_doxygen.sh
 create mode 100755 doc/api/generate_examples.sh
 create mode 100644 doc/api/meson.build
 create mode 100644 doc/meson.build

-- 
2.18.0

             reply	other threads:[~2018-08-31 18:21 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-31 18:20 Luca Boccassi [this message]
2018-08-31 18:20 ` [dpdk-dev] [PATCH 1/4] mk: use script to generate examples.dox Luca Boccassi
2018-09-03  0:54   ` Thomas Monjalon
2018-09-03  9:07     ` Luca Boccassi
2018-09-07 16:13       ` Bruce Richardson
2018-09-07 16:56         ` Luca Boccassi
2018-08-31 18:20 ` [dpdk-dev] [PATCH 2/4] mk: use templated doxygen config, modified on the fly Luca Boccassi
2018-09-03  1:03   ` Thomas Monjalon
2018-09-03  9:08     ` Luca Boccassi
2018-08-31 18:20 ` [dpdk-dev] [PATCH 3/4] build: use same version as make showversion in Meson Luca Boccassi
2018-09-03  1:04   ` Thomas Monjalon
2018-08-31 18:20 ` [dpdk-dev] [PATCH 4/4] build: generate API documentation with Meson Luca Boccassi
2018-09-03  1:09   ` Thomas Monjalon
2018-09-03  9:34     ` Luca Boccassi
2018-09-07 16:31   ` Bruce Richardson
2018-09-07 16:56     ` Luca Boccassi
2018-09-07 16:55 ` [dpdk-dev] [PATCH v2 1/4] mk: use script to generate examples.dox Luca Boccassi
2018-09-07 16:55   ` [dpdk-dev] [PATCH v2 2/4] mk: use templated doxygen config, modified on the fly Luca Boccassi
2018-09-07 16:55   ` [dpdk-dev] [PATCH v2 3/4] build: use same version as make showversion in Meson Luca Boccassi
2018-09-07 16:55   ` [dpdk-dev] [PATCH v2 4/4] build: generate API documentation with Meson Luca Boccassi
2018-09-10 15:47     ` Bruce Richardson
2018-09-10 16:15       ` Luca Boccassi
2018-09-10 15:49   ` [dpdk-dev] [PATCH v2 1/4] mk: use script to generate examples.dox Bruce Richardson
2018-09-10 16:13   ` [dpdk-dev] [PATCH v3 " Luca Boccassi
2018-09-10 16:13     ` [dpdk-dev] [PATCH v3 2/4] mk: use templated doxygen config, modified on the fly Luca Boccassi
2018-09-10 16:13     ` [dpdk-dev] [PATCH v3 3/4] build: use same version as make showversion in Meson Luca Boccassi
2018-09-10 16:13     ` [dpdk-dev] [PATCH v3 4/4] build: generate API documentation with Meson Luca Boccassi
2018-09-10 17:30       ` Bruce Richardson
2018-09-10 17:32         ` Bruce Richardson
2018-09-10 17:35         ` Luca Boccassi
2018-09-10 20:09 ` [dpdk-dev] [PATCH v4 1/4] mk: use script to generate examples.dox Luca Boccassi
2018-09-10 20:09   ` [dpdk-dev] [PATCH v4 2/4] mk: use templated doxygen config, modified on the fly Luca Boccassi
2018-09-10 20:09   ` [dpdk-dev] [PATCH v4 3/4] build: use same version as make showversion in Meson Luca Boccassi
2018-09-10 20:10   ` [dpdk-dev] [PATCH v4 4/4] build: generate API documentation with Meson Luca Boccassi
2018-09-11 20:42 ` [dpdk-dev] [PATCH v5 1/4] mk: use script to generate examples.dox Luca Boccassi
2018-09-11 20:42   ` [dpdk-dev] [PATCH v5 2/4] mk: use templated doxygen config, modified on the fly Luca Boccassi
2018-09-11 20:42   ` [dpdk-dev] [PATCH v5 3/4] build: use same version as make showversion in Meson Luca Boccassi
2018-09-11 20:42   ` [dpdk-dev] [PATCH v5 4/4] build: generate API documentation with Meson Luca Boccassi
2018-09-18 13:48     ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180831182055.30772-1-bluca@debian.org \
    --to=bluca@debian.org \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ https://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git