mirror of
https://gitlab.com/buildroot.org/buildroot.git
synced 2026-10-01 06:21:56 -09: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>
This commit is contained in:
committed by
Arnout Vandecappelle
parent
ccc12c0f24
commit
4286c89f9d
@@ -76,12 +76,9 @@ Just like the generic infrastructure, the autotools infrastructure
|
|||||||
works by defining a number of variables before calling the
|
works by defining a number of variables before calling the
|
||||||
+autotools-package+ macro.
|
+autotools-package+ macro.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in the
|
All the package metadata information variables that exist in the
|
||||||
generic infrastructure also exist in the autotools infrastructure:
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+LIBFOO_VERSION+, +LIBFOO_SOURCE+,
|
exist in the autotools infrastructure.
|
||||||
+LIBFOO_PATCH+, +LIBFOO_SITE+,
|
|
||||||
+LIBFOO_SUBDIR+, +LIBFOO_DEPENDENCIES+,
|
|
||||||
+LIBFOO_INSTALL_STAGING+, +LIBFOO_INSTALL_TARGET+.
|
|
||||||
|
|
||||||
A few additional variables, specific to the autotools infrastructure,
|
A few additional variables, specific to the autotools infrastructure,
|
||||||
can also be defined. Many of them are only useful in very specific
|
can also be defined. Many of them are only useful in very specific
|
||||||
|
|||||||
@@ -64,10 +64,9 @@ Just like the generic infrastructure, the Cargo infrastructure works
|
|||||||
by defining a number of variables before calling the +cargo-package+
|
by defining a number of variables before calling the +cargo-package+
|
||||||
or +host-cargo-package+ macros.
|
or +host-cargo-package+ macros.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in
|
All the package metadata information variables that exist in the
|
||||||
the generic infrastructure also exist in the Cargo infrastructure:
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+FOO_VERSION+, +FOO_SOURCE+, +FOO_PATCH+, +FOO_SITE+,
|
exist in the Cargo infrastructure.
|
||||||
+FOO_DEPENDENCIES+, +FOO_LICENSE+, +FOO_LICENSE_FILES+, etc.
|
|
||||||
|
|
||||||
A few additional variables, specific to the Cargo infrastructure, can
|
A few additional variables, specific to the Cargo infrastructure, can
|
||||||
also be defined. Many of them are only useful in very specific cases,
|
also be defined. Many of them are only useful in very specific cases,
|
||||||
|
|||||||
@@ -75,11 +75,9 @@ Just like the generic infrastructure, the CMake infrastructure works
|
|||||||
by defining a number of variables before calling the +cmake-package+
|
by defining a number of variables before calling the +cmake-package+
|
||||||
macro.
|
macro.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in
|
All the package metadata information variables that exist in the
|
||||||
the generic infrastructure also exist in the CMake infrastructure:
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+LIBFOO_VERSION+, +LIBFOO_SOURCE+, +LIBFOO_PATCH+, +LIBFOO_SITE+,
|
exist in the CMake infrastructure.
|
||||||
+LIBFOO_SUBDIR+, +LIBFOO_DEPENDENCIES+, +LIBFOO_INSTALL_STAGING+,
|
|
||||||
+LIBFOO_INSTALL_TARGET+.
|
|
||||||
|
|
||||||
A few additional variables, specific to the CMake infrastructure, can
|
A few additional variables, specific to the CMake infrastructure, can
|
||||||
also be defined. Many of them are only useful in very specific cases,
|
also be defined. Many of them are only useful in very specific cases,
|
||||||
|
|||||||
@@ -56,16 +56,15 @@ The main macro of the Go package infrastructure is
|
|||||||
ability to build host packages is also available, with the
|
ability to build host packages is also available, with the
|
||||||
+host-golang-package+ macro.
|
+host-golang-package+ macro.
|
||||||
Host packages built by +host-golang-package+ macro should depend on
|
Host packages built by +host-golang-package+ macro should depend on
|
||||||
BR2_PACKAGE_HOST_GO_HOST_ARCH_SUPPORTS.
|
+BR2_PACKAGE_HOST_GO_HOST_ARCH_SUPPORTS+.
|
||||||
|
|
||||||
Just like the generic infrastructure, the Go infrastructure works
|
Just like the generic infrastructure, the Go infrastructure works
|
||||||
by defining a number of variables before calling the +golang-package+.
|
by defining a number of variables before calling the +golang-package+
|
||||||
|
macro.
|
||||||
|
|
||||||
All the package metadata information variables that exist in the
|
All the package metadata information variables that exist in the
|
||||||
xref:generic-package-reference[generic package infrastructure] also
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
exist in the Go infrastructure: +FOO_VERSION+, +FOO_SOURCE+,
|
exist in the Go infrastructure.
|
||||||
+FOO_PATCH+, +FOO_SITE+, +FOO_SUBDIR+, +FOO_DEPENDENCIES+,
|
|
||||||
+FOO_LICENSE+, +FOO_LICENSE_FILES+, +FOO_INSTALL_STAGING+, etc.
|
|
||||||
|
|
||||||
Note that it is not necessary to add +host-go+ in the
|
Note that it is not necessary to add +host-go+ in the
|
||||||
+FOO_DEPENDENCIES+ variable of a package, since this basic dependency
|
+FOO_DEPENDENCIES+ variable of a package, since this basic dependency
|
||||||
|
|||||||
@@ -15,10 +15,16 @@ expose the package's +menuconfig+ target as +foo-menuconfig+ in
|
|||||||
Buildroot, and to handle the copying back and forth of the configuration
|
Buildroot, and to handle the copying back and forth of the configuration
|
||||||
file in a correct way.
|
file in a correct way.
|
||||||
|
|
||||||
The +kconfig-package+ infrastructure is based on the +generic-package+
|
The main macro of the kconfig package infrastructure is
|
||||||
infrastructure. All variables supported by +generic-package+ are
|
+kconfig-package+. It is similar to the +generic-package+ macro.
|
||||||
available in +kconfig-package+ as well. See
|
|
||||||
xref:generic-package-reference[] for more details.
|
Just like the generic infrastructure, the kconfig infrastructure works
|
||||||
|
by defining a number of variables before calling the +kconfig-package+
|
||||||
|
macro.
|
||||||
|
|
||||||
|
All the package metadata information variables that exist in the
|
||||||
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
|
exist in the kconfig infrastructure.
|
||||||
|
|
||||||
In order to use the +kconfig-package+ infrastructure for a Buildroot
|
In order to use the +kconfig-package+ infrastructure for a Buildroot
|
||||||
package, the minimally required lines in the +.mk+ file, in addition to
|
package, the minimally required lines in the +.mk+ file, in addition to
|
||||||
|
|||||||
@@ -73,16 +73,16 @@ infrastructures in Buildroot, respectively.
|
|||||||
|
|
||||||
The main macro of the LuaRocks package infrastructure is +luarocks-package+:
|
The main macro of the LuaRocks package infrastructure is +luarocks-package+:
|
||||||
like +generic-package+ it works by defining a number of variables providing
|
like +generic-package+ it works by defining a number of variables providing
|
||||||
metadata information about the package, and then calling +luarocks-package+.
|
metadata information about the package, and then calling the +luarocks-package+
|
||||||
|
macro.
|
||||||
|
|
||||||
Just like the generic infrastructure, the LuaRocks infrastructure works
|
Just like the generic infrastructure, the LuaRocks infrastructure works
|
||||||
by defining a number of variables before calling the +luarocks-package+
|
by defining a number of variables before calling the +luarocks-package+
|
||||||
macro.
|
macro.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in
|
All the package metadata information variables that exist in the
|
||||||
the generic infrastructure also exist in the LuaRocks infrastructure:
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+LUA_FOO_VERSION+, +LUA_FOO_SOURCE+, +LUA_FOO_SITE+,
|
exist in the LuaRocks infrastructure.
|
||||||
+LUA_FOO_DEPENDENCIES+, +LUA_FOO_LICENSE+, +LUA_FOO_LICENSE_FILES+.
|
|
||||||
|
|
||||||
Two of them are populated by the LuaRocks infrastructure (for the
|
Two of them are populated by the LuaRocks infrastructure (for the
|
||||||
+download+ step). If your package is not hosted on the LuaRocks mirror
|
+download+ step). If your package is not hosted on the LuaRocks mirror
|
||||||
|
|||||||
@@ -76,10 +76,9 @@ packages is also available, with the +host-meson-package+ macro.
|
|||||||
Just like the generic infrastructure, the Meson infrastructure works by defining
|
Just like the generic infrastructure, the Meson infrastructure works by defining
|
||||||
a number of variables before calling the +meson-package+ macro.
|
a number of variables before calling the +meson-package+ macro.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in the generic
|
All the package metadata information variables that exist in the
|
||||||
infrastructure also exist in the Meson infrastructure: +FOO_VERSION+,
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+FOO_SOURCE+, +FOO_PATCH+, +FOO_SITE+, +FOO_SUBDIR+, +FOO_DEPENDENCIES+,
|
exist in the Meson infrastructure.
|
||||||
+FOO_INSTALL_STAGING+, +FOO_INSTALL_TARGET+.
|
|
||||||
|
|
||||||
A few additional variables, specific to the Meson infrastructure, can also be
|
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
|
defined. Many of them are only useful in very specific cases, typical packages
|
||||||
|
|||||||
@@ -85,12 +85,9 @@ Just like the generic infrastructure, the Perl/CPAN infrastructure
|
|||||||
works by defining a number of variables before calling the
|
works by defining a number of variables before calling the
|
||||||
+perl-package+ macro.
|
+perl-package+ macro.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in the
|
All the package metadata information variables that exist in the
|
||||||
generic infrastructure also exist in the Perl/CPAN infrastructure:
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+PERL_FOO_VERSION+, +PERL_FOO_SOURCE+,
|
exist in the Perl/CPAN infrastructure.
|
||||||
+PERL_FOO_PATCH+, +PERL_FOO_SITE+,
|
|
||||||
+PERL_FOO_SUBDIR+, +PERL_FOO_DEPENDENCIES+,
|
|
||||||
+PERL_FOO_INSTALL_TARGET+.
|
|
||||||
|
|
||||||
Note that setting +PERL_FOO_INSTALL_STAGING+ to +YES+ has no effect
|
Note that setting +PERL_FOO_INSTALL_STAGING+ to +YES+ has no effect
|
||||||
unless a +PERL_FOO_INSTALL_STAGING_CMDS+ variable is defined. The perl
|
unless a +PERL_FOO_INSTALL_STAGING_CMDS+ variable is defined. The perl
|
||||||
|
|||||||
@@ -80,10 +80,7 @@ or +host-python-package+ macros.
|
|||||||
|
|
||||||
All the package metadata information variables that exist in the
|
All the package metadata information variables that exist in the
|
||||||
xref:generic-package-reference[generic package infrastructure] also
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
exist in the Python infrastructure: +PYTHON_FOO_VERSION+,
|
exist in the Python infrastructure.
|
||||||
+PYTHON_FOO_SOURCE+, +PYTHON_FOO_PATCH+, +PYTHON_FOO_SITE+,
|
|
||||||
+PYTHON_FOO_SUBDIR+, +PYTHON_FOO_DEPENDENCIES+, +PYTHON_FOO_LICENSE+,
|
|
||||||
+PYTHON_FOO_LICENSE_FILES+, +PYTHON_FOO_INSTALL_STAGING+, etc.
|
|
||||||
|
|
||||||
Note that:
|
Note that:
|
||||||
|
|
||||||
|
|||||||
@@ -51,13 +51,11 @@ Just like the generic infrastructure, the QMake infrastructure works
|
|||||||
by defining a number of variables before calling the +qmake-package+
|
by defining a number of variables before calling the +qmake-package+
|
||||||
macro.
|
macro.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in
|
All the package metadata information variables that exist in the
|
||||||
the generic infrastructure also exist in the QMake infrastructure:
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+LIBFOO_VERSION+, +LIBFOO_SOURCE+, +LIBFOO_PATCH+, +LIBFOO_SITE+,
|
exist in the QMake infrastructure.
|
||||||
+LIBFOO_SUBDIR+, +LIBFOO_DEPENDENCIES+, +LIBFOO_INSTALL_STAGING+,
|
|
||||||
+LIBFOO_INSTALL_TARGET+.
|
|
||||||
|
|
||||||
An additional variable, specific to the QMake infrastructure, can
|
A few additional variables, specific to the QMake infrastructure, can
|
||||||
also be defined.
|
also be defined.
|
||||||
|
|
||||||
* +LIBFOO_CONF_ENV+, to specify additional environment variables to
|
* +LIBFOO_CONF_ENV+, to specify additional environment variables to
|
||||||
|
|||||||
@@ -51,13 +51,9 @@ Just like the generic infrastructure, the +rebar+ infrastructure works
|
|||||||
by defining a number of variables before calling the +rebar-package+
|
by defining a number of variables before calling the +rebar-package+
|
||||||
macro.
|
macro.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in
|
All the package metadata information variables that exist in the
|
||||||
the generic infrastructure also exist in the +rebar+ infrastructure:
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+ERLANG_FOOBAR_VERSION+, +ERLANG_FOOBAR_SOURCE+,
|
exist in the +rebar+ infrastructure.
|
||||||
+ERLANG_FOOBAR_PATCH+, +ERLANG_FOOBAR_SITE+,
|
|
||||||
+ERLANG_FOOBAR_SUBDIR+, +ERLANG_FOOBAR_DEPENDENCIES+,
|
|
||||||
+ERLANG_FOOBAR_INSTALL_STAGING+, +ERLANG_FOOBAR_INSTALL_TARGET+,
|
|
||||||
+ERLANG_FOOBAR_LICENSE+ and +ERLANG_FOOBAR_LICENSE_FILES+.
|
|
||||||
|
|
||||||
A few additional variables, specific to the +rebar+ infrastructure,
|
A few additional variables, specific to the +rebar+ infrastructure,
|
||||||
can also be defined. Many of them are only useful in very specific
|
can also be defined. Many of them are only useful in very specific
|
||||||
|
|||||||
@@ -51,13 +51,11 @@ Just like the generic infrastructure, the Waf infrastructure works
|
|||||||
by defining a number of variables before calling the +waf-package+
|
by defining a number of variables before calling the +waf-package+
|
||||||
macro.
|
macro.
|
||||||
|
|
||||||
First, all the package metadata information variables that exist in
|
All the package metadata information variables that exist in the
|
||||||
the generic infrastructure also exist in the Waf infrastructure:
|
xref:generic-package-reference[generic package infrastructure] also
|
||||||
+LIBFOO_VERSION+, +LIBFOO_SOURCE+, +LIBFOO_PATCH+, +LIBFOO_SITE+,
|
exist in the Waf infrastructure.
|
||||||
+LIBFOO_SUBDIR+, +LIBFOO_DEPENDENCIES+, +LIBFOO_INSTALL_STAGING+,
|
|
||||||
+LIBFOO_INSTALL_TARGET+.
|
|
||||||
|
|
||||||
An additional variable, specific to the Waf infrastructure, can
|
A few additional variables, specific to the Waf infrastructure, can
|
||||||
also be defined.
|
also be defined.
|
||||||
|
|
||||||
* +LIBFOO_SUBDIR+ may contain the name of a subdirectory inside the
|
* +LIBFOO_SUBDIR+ may contain the name of a subdirectory inside the
|
||||||
|
|||||||
Reference in New Issue
Block a user