docs/manual: small fixes and enhancements to adding generic packages

Add overall description of LIBFOO_DEVICES and LIBFOO_PERMISSIONS.
Fix line numbers.

Cc: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Acked-by: Samuel Martin <s.martin49@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
This commit is contained in:
Yann E. MORIN 2012-12-30 10:47:21 +00:00 committed by Peter Korsgaard
parent a45871bfc6
commit f1d44593a0

View File

@ -53,30 +53,32 @@ system is based on hand-written Makefiles or shell scripts.
37: $(eval $(generic-package)) 37: $(eval $(generic-package))
-------------------------------- --------------------------------
The Makefile begins on line 6 to 8 with metadata information: the The Makefile begins on line 6 to 10 with metadata information: the
version of the package (+LIBFOO_VERSION+), the name of the version of the package (+LIBFOO_VERSION+), the name of the
tarball containing the package (+LIBFOO_SOURCE+) and the tarball containing the package (+LIBFOO_SOURCE+) the
Internet location at which the tarball can be downloaded Internet location at which the tarball can be downloaded from
(+LIBFOO_SITE+). All variables must start with the same prefix, (+LIBFOO_SITE+), the license (+LIBFOO_LICENSE+) and file with the
+LIBFOO_+ in this case. This prefix is always the uppercased license text (+LIBFOO_LICENSE_FILES+). All variables must start with
version of the package name (see below to understand where the package the same prefix, +LIBFOO_+ in this case. This prefix is always the
name is defined). uppercased version of the package name (see below to understand where
the package name is defined).
On line 9, we specify that this package wants to install something to On line 11, we specify that this package wants to install something to
the staging space. This is often needed for libraries, since they must the staging space. This is often needed for libraries, since they must
install header files and other development files in the staging space. install header files and other development files in the staging space.
This will ensure that the commands listed in the This will ensure that the commands listed in the
+LIBFOO_INSTALL_STAGING_CMDS+ variable will be executed. +LIBFOO_INSTALL_STAGING_CMDS+ variable will be executed.
On line 10, we specify the list of dependencies this package relies On line 12, we specify the list of dependencies this package relies
on. These dependencies are listed in terms of lower-case package names, on. These dependencies are listed in terms of lower-case package names,
which can be packages for the target (without the +host-+ which can be packages for the target (without the +host-+
prefix) or packages for the host (with the +host-+) prefix). prefix) or packages for the host (with the +host-+) prefix).
Buildroot will ensure that all these packages are built and installed Buildroot will ensure that all these packages are built and installed
'before' the current package starts its configuration. 'before' the current package starts its configuration.
The rest of the Makefile defines what should be done at the different The rest of the Makefile, lines 14..27, defines what should be done
steps of the package configuration, compilation and installation. at the different steps of the package configuration, compilation and
installation.
+LIBFOO_BUILD_CMDS+ tells what steps should be performed to +LIBFOO_BUILD_CMDS+ tells what steps should be performed to
build the package. +LIBFOO_INSTALL_STAGING_CMDS+ tells what build the package. +LIBFOO_INSTALL_STAGING_CMDS+ tells what
steps should be performed to install the package in the staging space. steps should be performed to install the package in the staging space.
@ -87,7 +89,13 @@ All these steps rely on the +$(@D)+ variable, which
contains the directory where the source code of the package has been contains the directory where the source code of the package has been
extracted. extracted.
Finally, on line 35, we call the +generic-package+ which On line 29..31, we define a device-node file used by this package
(+LIBFOO_DEVICES+).
On line 33..35, we define the permissions to set to specific files
installed by this package (+LIBFOO_PERMISSIONS+).
Finally, on line 37, we call the +generic-package+ function, which
generates, according to the variables defined previously, all the generates, according to the variables defined previously, all the
Makefile code necessary to make your package working. Makefile code necessary to make your package working.