c9b07cbdd0
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>
84 lines
2.8 KiB
Plaintext
84 lines
2.8 KiB
Plaintext
// -*- mode:doc; -*-
|
|
// vim: set syntax=asciidoc:
|
|
|
|
=== Infrastructure for QMake-based packages
|
|
|
|
[[qmake-package-tutorial]]
|
|
|
|
==== +qmake-package+ tutorial
|
|
|
|
First, let's see how to write a +.mk+ file for a QMake-based package, with
|
|
an example :
|
|
|
|
------------------------
|
|
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 = QT_CONFIG+=bar QT_CONFIG-=baz
|
|
11: LIBFOO_DEPENDENCIES = bar
|
|
12:
|
|
13: $(eval $(qmake-package))
|
|
------------------------
|
|
|
|
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.
|
|
|
|
On line 11, we tell Buildroot the dependencies of libfoo.
|
|
|
|
Finally, on line line 13, we invoke the +qmake-package+
|
|
macro that generates all the Makefile rules that actually allows the
|
|
package to be built.
|
|
|
|
[[qmake-package-reference]]
|
|
|
|
==== +qmake-package+ reference
|
|
|
|
The main macro of the QMake package infrastructure is +qmake-package+.
|
|
It is similar to the +generic-package+ macro.
|
|
|
|
Just like the generic infrastructure, the QMake infrastructure works
|
|
by defining a number of variables before calling the +qmake-package+
|
|
macro.
|
|
|
|
All the package metadata information variables that exist in the
|
|
xref:generic-package-reference[generic package infrastructure] also
|
|
exist in the QMake infrastructure.
|
|
|
|
A few additional variables, specific to the QMake infrastructure, can
|
|
also be defined.
|
|
|
|
* +LIBFOO_CONF_ENV+, to specify additional environment variables to
|
|
pass to the +qmake+ script for the configuration step. By default, empty.
|
|
|
|
* +LIBFOO_CONF_OPTS+, to specify additional options to pass to the
|
|
+qmake+ script for the configuration step. By default, empty.
|
|
|
|
* +LIBFOO_MAKE_ENV+, to specify additional environment variables to the
|
|
+make+ command during the build and install steps. By default, empty.
|
|
|
|
* +LIBFOO_MAKE_OPTS+, to specify additional targets to pass to the
|
|
+make+ command during the build step. By default, empty.
|
|
|
|
* +LIBFOO_INSTALL_STAGING_OPTS+, to specify additional targets to pass
|
|
to the +make+ command during the staging installation step. By default,
|
|
+install+.
|
|
|
|
* +LIBFOO_INSTALL_TARGET_OPTS+, to specify additional targets to pass
|
|
to the +make+ command during the target installation step. By default,
|
|
+install+.
|
|
|
|
* +LIBFOO_SYNC_QT_HEADERS+, to run syncqt.pl before qmake. Some packages
|
|
need this to have a properly populated include directory before
|
|
running the build.
|