2017-10-29 14:10:52 +01:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
|
|
|
|
|
2018-05-15 21:51:53 +02:00
|
|
|
=== Infrastructure for Meson-based packages
|
2017-10-29 14:10:52 +01:00
|
|
|
|
|
|
|
|
[[meson-package-tutorial]]
|
|
|
|
|
|
|
|
|
|
==== +meson-package+ tutorial
|
|
|
|
|
|
|
|
|
|
http://mesonbuild.com[Meson] is an open source build system meant to be both
|
2018-05-15 21:51:53 +02:00
|
|
|
extremely fast, and, even more importantly, as user friendly as possible. It
|
|
|
|
|
uses https://ninja-build.org[Ninja] as a companion tool to perform the actual
|
|
|
|
|
build operations.
|
2017-10-29 14:10:52 +01:00
|
|
|
|
2018-05-15 21:51:53 +02:00
|
|
|
Let's see how to write a +.mk+ file for a Meson-based package, with an example:
|
2017-10-29 14:10:52 +01:00
|
|
|
|
|
|
|
|
------------------------------
|
|
|
|
|
01: ################################################################################
|
|
|
|
|
02: #
|
|
|
|
|
03: # foo
|
|
|
|
|
04: #
|
|
|
|
|
05: ################################################################################
|
|
|
|
|
06:
|
|
|
|
|
07: FOO_VERSION = 1.0
|
|
|
|
|
08: FOO_SOURCE = foo-$(FOO_VERSION).tar.gz
|
|
|
|
|
09: FOO_SITE = http://www.foosoftware.org/download
|
2018-04-05 20:13:24 +02:00
|
|
|
10: FOO_LICENSE = GPL-3.0+
|
2017-10-29 14:10:52 +01:00
|
|
|
11: FOO_LICENSE_FILES = COPYING
|
|
|
|
|
12: FOO_INSTALL_STAGING = YES
|
|
|
|
|
13:
|
2018-05-15 21:51:53 +02:00
|
|
|
14: FOO_DEPENDENCIES = host-pkgconf bar
|
2017-10-29 14:10:52 +01:00
|
|
|
15:
|
2018-05-15 21:51:53 +02:00
|
|
|
16: ifeq ($(BR2_PACKAGE_BAZ),y)
|
|
|
|
|
17: FOO_CONF_OPTS += -Dbaz=true
|
|
|
|
|
18: FOO_DEPENDENCIES += baz
|
|
|
|
|
19: else
|
|
|
|
|
20: FOO_CONF_OPTS += -Dbaz=false
|
|
|
|
|
21: endif
|
2017-10-29 14:10:52 +01:00
|
|
|
22:
|
2018-05-15 21:51:53 +02:00
|
|
|
23: $(eval $(meson-package))
|
2017-10-29 14:10:52 +01:00
|
|
|
--------------------------------
|
|
|
|
|
|
|
|
|
|
The Makefile starts with the definition of the standard variables for package
|
|
|
|
|
declaration (lines 7 to 11).
|
|
|
|
|
|
2018-05-15 21:51:53 +02:00
|
|
|
On line line 23, we invoke the +meson-package+ macro that generates all the
|
|
|
|
|
Makefile rules that actually allows the package to be built.
|
2017-10-29 14:10:52 +01:00
|
|
|
|
2018-05-15 21:51:53 +02:00
|
|
|
In the example, +host-pkgconf+ and +bar+ are declared as dependencies in
|
|
|
|
|
+FOO_DEPENDENCIES+ at line 14 because the Meson build file of +foo+ uses
|
|
|
|
|
`pkg-config` to determine the compilation flags and libraries of package +bar+.
|
2017-10-29 14:10:52 +01:00
|
|
|
|
2018-05-15 21:51:53 +02:00
|
|
|
Note that it is not necessary to add +host-meson+ in the +FOO_DEPENDENCIES+
|
|
|
|
|
variable of a package, since this basic dependency is automatically added as
|
|
|
|
|
needed by the Meson package infrastructure.
|
2017-10-29 14:10:52 +01:00
|
|
|
|
2018-05-15 21:51:53 +02:00
|
|
|
If the "baz" package is selected, then support for the "baz" feature in "foo" is
|
|
|
|
|
activated by adding +-Dbaz=true+ to +FOO_CONF_OPTS+ at line 17, as specified in
|
|
|
|
|
the +meson_options.txt+ file in "foo" source tree. The "baz" package is also
|
|
|
|
|
added to +FOO_DEPENDENCIES+. Note that the support for +baz+ is explicitly
|
|
|
|
|
disabled at line 20, if the package is not selected.
|
2017-10-29 14:10:52 +01:00
|
|
|
|
|
|
|
|
To sum it up, to add a new meson-based package, the Makefile example can be
|
|
|
|
|
copied verbatim then edited to replace all occurences of +FOO+ with the
|
|
|
|
|
uppercase name of the new package and update the values of the standard
|
|
|
|
|
variables.
|
2018-05-15 21:51:53 +02:00
|
|
|
|
|
|
|
|
[[meson-package-reference]]
|
|
|
|
|
|
|
|
|
|
==== +meson-package+ reference
|
|
|
|
|
|
|
|
|
|
The main macro of the Meson package infrastructure is +meson-package+. It is
|
|
|
|
|
similar to the +generic-package+ macro. The ability to have target and host
|
|
|
|
|
packages is also available, with the +host-meson-package+ macro.
|
|
|
|
|
|
|
|
|
|
Just like the generic infrastructure, the Meson infrastructure works by defining
|
|
|
|
|
a number of variables before calling the +meson-package+ macro.
|
|
|
|
|
|
docs/manual: standardize references to the generic infra
Currently the text for each package infra that mentions the usage of
variables already provided by the generic infra diverge from each other:
- some (golang, kconfig, python) add a cross-referece to the generic
infra chapter;
- kconfig does not list any example;
- some mention _LICENSE as an example, others don't;
- some (cargo, golang, python) add an 'etc.' at the end of the examples,
giving the idea that can be more symbols provided by the generic
infra than the ones listed;
- most have the text 'works by defining a number of variables before
calling the +<macro-name>+ macro', except golang and kconfig;
- some actually list 'A few additional variables' but keep using some
old reference as 'An additional variable';
- some say 'First, all the package metadata' and other only 'All the
package metadata';
- most mention _SUBDIR as an example of variable supported by the
generic infra, even the generic infra manual not mentioning it.
Improve the correctness for the manual by standardizing the text among
the package infras:
- use the same text "All the package metadata information variables that
exist in the generic package infrastructure also exist in the
<name> infrastructure:" for all of them;
- add the cross-reference for all of them;
- remove the examples of variables inherited from the generic infra -
this also solves the _SUBDIR problem, there no longer is any reference
to _SUBDIR;
- wrap the modified text at 80 columns;
- add "macro" to golang and luarocks infra;
- use "A few additional variables" for qmake and waf.
At same time, add a missing format on golang manual for
BR2_PACKAGE_HOST_GO_HOST_ARCH_SUPPORTS.
Cc: Eric Le Bihan <eric.le.bihan.dev@free.fr>
Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com>
[Arnout:
- remove the examples;
- add "the" where "macro" was added;
- rewrite the preceding paragraphs for kconfig to make it more
consistent.
]
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
(cherry picked from commit 4286c89f9d987f5f3bcbb14dfd58ba440944f4c2)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2023-01-02 00:36:53 +01:00
|
|
|
All the package metadata information variables that exist in the
|
|
|
|
|
xref:generic-package-reference[generic package infrastructure] also
|
|
|
|
|
exist in the Meson infrastructure.
|
2018-05-15 21:51:53 +02:00
|
|
|
|
|
|
|
|
A few additional variables, specific to the Meson infrastructure, can also be
|
|
|
|
|
defined. Many of them are only useful in very specific cases, typical packages
|
|
|
|
|
will therefore only use a few of them.
|
|
|
|
|
|
2018-10-11 11:57:53 +02:00
|
|
|
* +FOO_SUBDIR+ may contain the name of a subdirectory inside the
|
|
|
|
|
package that contains the main meson.build file. This is useful,
|
|
|
|
|
if for example, the main meson.build file is not at the root of
|
|
|
|
|
the tree extracted by the tarball. If +HOST_FOO_SUBDIR+ is not
|
|
|
|
|
specified, it defaults to +FOO_SUBDIR+.
|
|
|
|
|
|
2018-05-15 21:51:53 +02:00
|
|
|
* +FOO_CONF_ENV+, to specify additional environment variables to pass to
|
|
|
|
|
+meson+ for the configuration step. By default, empty.
|
|
|
|
|
|
|
|
|
|
* +FOO_CONF_OPTS+, to specify additional options to pass to +meson+ for the
|
|
|
|
|
configuration step. By default, empty.
|
|
|
|
|
|
infra/pkg-meson: allow packages to pass custom compiler/linker flags
Meson does not allow to pass CFLAGS/LDFLAGS/CXXFLAGS via the environment
or via command-line arguments or options (instead, those flags from the
environment are passed to the host compiler, which is seldom what we
need). The only way to pas those flags is via the cross-compilation.conf
file.
Add LIBFOO_CFLAGS, LIBFOO_LDFLAGS and LIBFOO_CXXFLAGS variables to allow
packages to provide their own flags, possibly overriding the generic
ones entirely, as we allow for other infras. Those per-package flags will
then be used to generate the per-package cross-compilation.conf.
This means that the meson infra is the first and only infra for which
FOO_CFLAGS, FOO_LDFLAGS, and FOO_CXXFLAGS are meaningful, while for the
other infras, they are just variables private to the package itself.
Instead of naming those variables after the meson infra (e.g.
FOO_MESON_CFLAGS), we name them with a generic name, as maybe, just
maybe, we could also change the other infras to also recognise those
variables.
Just like for the HOST_MESON_SED_CFLAGS etc., we need to add auxiliary
variables to do convert the shell-formatted argument list into the
JSON-formatted list that meson expects. We can't use a pure-make
construct because the CFLAGS can contain quoting that needs to be
expanded by the shell. Similarly, we need a condition on the strip'ed
variable to avoid passing empty arguments.
To mimic this feature for packages that are built from the SDK, we also
install a templatised version of cross-compilation.conf, with three new
placeholders for custom flags. If a user wants to build a package that
needs custom flags, they can use that template to generate a per-package
cross-compilation.conf.
Signed-off-by: Peter Seiderer <ps.report@gmx.net>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Cc: Adam Duskett <aduskett@gmail.com>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Tested-by: Peter Seiderer <ps.report@gmx.net>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2019-06-24 22:25:48 +02:00
|
|
|
* +FOO_CFLAGS+, to specify compiler arguments added to the package specific
|
|
|
|
|
+cross-compile.conf+ file +c_args+ property. By default, the value of
|
|
|
|
|
+TARGET_CFLAGS+.
|
|
|
|
|
|
|
|
|
|
* +FOO_CXXFLAGS+, to specify compiler arguments added to the package specific
|
|
|
|
|
+cross-compile.conf+ file +cpp_args+ property. By default, the value of
|
|
|
|
|
+TARGET_CXXFLAGS+.
|
|
|
|
|
|
|
|
|
|
* +FOO_LDFLAGS+, to specify compiler arguments added to the package specific
|
|
|
|
|
+cross-compile.conf+ file +c_link_args+ and +cpp_link_args+ properties. By
|
|
|
|
|
default, the value of +TARGET_LDFLAGS+.
|
|
|
|
|
|
2019-09-28 22:04:30 +02:00
|
|
|
* +FOO_MESON_EXTRA_BINARIES+, to specify a space-separated list of programs
|
|
|
|
|
to add to the `[binaries]` section of the meson `cross-compilation.conf`
|
|
|
|
|
configuration file. The format is `program-name='/path/to/program'`, with
|
|
|
|
|
no space around the +=+ sign, and with the path of the program between
|
|
|
|
|
single quotes. By default, empty. Note that Buildroot already sets the
|
|
|
|
|
correct values for +c+, +cpp+, +ar+, +strip+, and +pkgconfig+.
|
|
|
|
|
|
2020-03-11 12:22:55 +01:00
|
|
|
* +FOO_MESON_EXTRA_PROPERTIES+, to specify a space-separated list of
|
|
|
|
|
properties to add to the `[properties]` section of the meson
|
|
|
|
|
`cross-compilation.conf` configuration file. The format is
|
|
|
|
|
`property-name=<value>` with no space around the +=+ sign, and with
|
|
|
|
|
single quotes around string values. By default, empty. Note that
|
|
|
|
|
Buildroot already sets values for +needs_exe_wrapper+, +c_args+,
|
|
|
|
|
+c_link_args+, +cpp_args+, +cpp_link_args+, +sys_root+, and
|
|
|
|
|
+pkg_config_libdir+.
|
|
|
|
|
|
2018-05-15 21:51:53 +02:00
|
|
|
* +FOO_NINJA_ENV+, to specify additional environment variables to pass to
|
|
|
|
|
+ninja+, meson companion tool in charge of the build operations. By default,
|
|
|
|
|
empty.
|
2018-12-26 09:52:28 +01:00
|
|
|
|
|
|
|
|
* +FOO_NINJA_OPTS+, to specify a space-separated list of targets to build. By
|
|
|
|
|
default, empty, to build the default target(s).
|
