2016-10-30 17:02:14 +01:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
|
|
|
|
|
|
|
|
|
=== Infrastructure for Waf-based packages
|
|
|
|
|
|
|
|
|
|
[[waf-package-tutorial]]
|
|
|
|
|
|
|
|
|
|
==== +waf-package+ tutorial
|
|
|
|
|
|
|
|
|
|
First, let's see how to write a +.mk+ file for a Waf-based package, with
|
|
|
|
|
an example :
|
|
|
|
|
|
2024-07-12 20:23:24 +02:00
|
|
|
----
|
2016-10-30 17:02:14 +01:00
|
|
|
01: ################################################################################
|
|
|
|
|
02: #
|
|
|
|
|
03: # libfoo
|
|
|
|
|
04: #
|
|
|
|
|
05: ################################################################################
|
|
|
|
|
06:
|
|
|
|
|
07: LIBFOO_VERSION = 1.0
|
|
|
|
|
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
|
|
|
|
|
09: LIBFOO_SITE = http://www.foosoftware.org/download
|
|
|
|
|
10: LIBFOO_CONF_OPTS = --enable-bar --disable-baz
|
|
|
|
|
11: LIBFOO_DEPENDENCIES = bar
|
|
|
|
|
12:
|
|
|
|
|
13: $(eval $(waf-package))
|
2024-07-12 20:23:24 +02:00
|
|
|
----
|
2016-10-30 17:02:14 +01:00
|
|
|
|
|
|
|
|
On line 7, we declare the version of the package.
|
|
|
|
|
|
|
|
|
|
On line 8 and 9, we declare the name of the tarball (xz-ed tarball
|
|
|
|
|
recommended) and the location of the tarball on the Web. Buildroot
|
|
|
|
|
will automatically download the tarball from this location.
|
|
|
|
|
|
|
|
|
|
On line 10, we tell Buildroot what options to enable for libfoo.
|
|
|
|
|
|
2020-08-22 21:20:01 +02:00
|
|
|
On line 11, we tell Buildroot the dependencies of libfoo.
|
2016-10-30 17:02:14 +01:00
|
|
|
|
|
|
|
|
Finally, on line line 13, we invoke the +waf-package+
|
|
|
|
|
macro that generates all the Makefile rules that actually allows the
|
|
|
|
|
package to be built.
|
|
|
|
|
|
|
|
|
|
[[waf-package-reference]]
|
|
|
|
|
|
|
|
|
|
==== +waf-package+ reference
|
|
|
|
|
|
|
|
|
|
The main macro of the Waf package infrastructure is +waf-package+.
|
|
|
|
|
It is similar to the +generic-package+ macro.
|
|
|
|
|
|
|
|
|
|
Just like the generic infrastructure, the Waf infrastructure works
|
|
|
|
|
by defining a number of variables before calling the +waf-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 Waf infrastructure.
|
2016-10-30 17:02:14 +01:00
|
|
|
|
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
|
|
|
A few additional variables, specific to the Waf infrastructure, can
|
2016-10-30 17:02:14 +01:00
|
|
|
also be defined.
|
|
|
|
|
|
2018-10-11 11:57:52 +02:00
|
|
|
* +LIBFOO_SUBDIR+ may contain the name of a subdirectory inside the
|
|
|
|
|
package that contains the main wscript file. This is useful,
|
|
|
|
|
if for example, the main wscript file is not at the root of
|
|
|
|
|
the tree extracted by the tarball. If +HOST_LIBFOO_SUBDIR+ is not
|
|
|
|
|
specified, it defaults to +LIBFOO_SUBDIR+.
|
|
|
|
|
|
2016-10-30 17:02:14 +01:00
|
|
|
* +LIBFOO_NEEDS_EXTERNAL_WAF+ can be set to +YES+ or +NO+ to tell
|
|
|
|
|
Buildroot to use the bundled +waf+ executable. If set to +NO+, the
|
|
|
|
|
default, then Buildroot will use the waf executable provided in the
|
2018-12-26 22:32:46 +01:00
|
|
|
package source tree; if set to +YES+, then Buildroot will download,
|
2016-10-30 17:02:14 +01:00
|
|
|
install waf as a host tool and use it to build the package.
|
2016-12-11 16:10:15 +01:00
|
|
|
|
|
|
|
|
* +LIBFOO_WAF_OPTS+, to specify additional options to pass to the
|
|
|
|
|
+waf+ script at every step of the package build process: configure,
|
|
|
|
|
build and installation. By default, empty.
|
|
|
|
|
|
|
|
|
|
* +LIBFOO_CONF_OPTS+, to specify additional options to pass to the
|
|
|
|
|
+waf+ script for the configuration step. By default, empty.
|
|
|
|
|
|
|
|
|
|
* +LIBFOO_BUILD_OPTS+, to specify additional options to pass to the
|
|
|
|
|
+waf+ script during the build step. By default, empty.
|
|
|
|
|
|
|
|
|
|
* +LIBFOO_INSTALL_STAGING_OPTS+, to specify additional options to pass
|
|
|
|
|
to the +waf+ script during the staging installation step. By default,
|
|
|
|
|
empty.
|
|
|
|
|
|
|
|
|
|
* +LIBFOO_INSTALL_TARGET_OPTS+, to specify additional options to pass
|
|
|
|
|
to the +waf+ script during the target installation step. By default,
|
|
|
|
|
empty.
|
