diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index f325f0e233..2b3031538f 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -628,7 +628,8 @@ Checks the size of the kernel image against - KERNEL_IMAGE_MAXSIZE when set. + KERNEL_IMAGE_MAXSIZE + when set. diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index e3272fec79..da7a986b68 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -293,6 +293,28 @@ + AUTO_LIBNAME_PKGS + + AUTO_LIBNAME_PKGS[doc] = "Specifies which packages should be checked for libraries and renamed according to Debian library package naming." + + + + When the + debian + class is inherited, which is the default behavior, + AUTO_LIBNAME_PKGS specifies which + packages should be checked for libraries and renamed + according to Debian library package naming. + + + + The default value is "${PACKAGES}", which causes the + OpenEmbedded build system to act on all packages that are + explicitly generated by the recipe. + + + + AUTO_SYSLINUXMENU AUTO_SYSLINUXMENU[doc] = "Enables creating an automatic menu for the syslinux bootloader." @@ -461,6 +483,18 @@ + BASE_WORKDIR + + BASE_WORKDIR[doc] = "Points to the base of the work directory for all recipes." + + + + Points to the base of the work directory for all recipes. + The default value is "${TMPDIR}/work". + + + + BB_DANGLINGAPPENDS_WARNONLY BB_DANGLINGAPPENDS_WARNONLY[doc] = "Defines how BitBake handles situations where an append file (.bbappend) has no corresponding recipe file (.bb)." @@ -1578,6 +1612,24 @@ + CLEANBROKEN + + CLEANBROKEN[doc] = "Prevents the build system from running 'make clean' during the do_configure task." + + + + If set to "1" within a recipe, + CLEANBROKEN specifies that + the make clean command does + not work for the software being built. + Consequently, the OpenEmbedded build system will not try + to run make clean during the + do_configure + task, which is the default behavior. + + + + COMBINED_FEATURES COMBINED_FEATURES[doc] = "A set of features common between MACHINE_FEATURES and DISTRO_FEATURES." @@ -1995,6 +2047,52 @@ + DEBIAN_NOAUTONAME + + DEBIAN_NOAUTONAME[doc] = "Prevents a particular package from being renamed according to Debian package naming." + + + + When the + debian + class is inherited, which is the default behavior, + DEBIAN_NOAUTONAME specifies a + particular package should not be renamed according to + Debian library package naming. + You must use the package name as an override when you + set this variable. + Here is an example from the fontconfig + recipe: + + DEBIAN_NOAUTONAME_fontconfig-utils = "1" + + + + + + DEBIANNAME + + DEBIANNAME[doc] = "Allows you to override the library name for an individual package." + + + + When the + debian + class is inherited, which is the default behavior, + DEBIANNAME allows you to override the + library name for an individual package. + Overriding the library name in these cases is rare. + You must use the package name as an override when you + set this variable. + Here is an example from the dbus + recipe: + + DEBIANNAME_${PN} = "dbus-1" + + + + + DEBUG_BUILD DEBUG_BUILD[doc] = "Specifies to build packages with debugging information. This influences the value of the SELECTED_OPTIMIZATION variable." @@ -2307,6 +2405,17 @@ + DISTRO_CODENAME + + DISTRO_CODENAME[doc] = "Specifies a codename for the distribution being built." + + + + Specifies a codename for the distribution being built. + + + + DISTRO_EXTRA_RDEPENDS DISTRO_EXTRA_RDEPENDS[doc] = "Specifies a list of distro-specific packages to add to all images. The variable only applies to the images that include packagegroup-base." @@ -2415,6 +2524,49 @@ + DISTRO_FEATURES_DEFAULT + + DISTRO_FEATURES_DEFAULT[doc] = "Provides the default list of distro features with the exception of any libc-specific features." + + + + A convenience variable that gives you the default + list of distro features with the exception of any + features specific to the C library + (libc). + + + + When creating a custom distribution, you might find it + useful to be able to reuse the default + DISTRO_FEATURES + options without the need to write out the full set. + Here is an example that uses + DISTRO_FEATURES_DEFAULT from a + custom distro configuration file: + + DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${DISTRO_FEATURES_LIBC} myfeature" + + + + + + DISTRO_FEATURES_LIBC + + DISTRO_FEATURES_LIBC[doc] = "Specifies the list of distro features that are specific to the C library (libc)." + + + + A convenience variable that specifies the list of distro + features that are specific to the C library + (libc). + Typically, these features are prefixed with "libc-" and + control which features are enabled at during the build + within the C library itself. + + + + DISTRO_NAME DISTRO_NAME[doc] = "The long name of the distribution." @@ -2766,6 +2918,27 @@ + EXTRA_AUTORECONF + + EXTRA_AUTORECONF[doc] = "Extra options passed to the autoreconf command, which is executed during do_configure." + + + + For recipes inheriting the autoconf + class, you can use EXTRA_AUTORECONF to + specify extra options to pass to the + autoreconf command that is + executed during the + do_configure + task. + + + + The default value is "--exclude=autopoint". + + + + EXTRA_IMAGE_FEATURES EXTRA_IMAGE_FEATURES[doc] = "The list of additional features to include in an image. Configure this variable in the conf/local.conf file in the Build Directory." @@ -5172,6 +5345,36 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + KERNEL_IMAGE_MAXSIZE + + KERNEL_IMAGE_MAXSIZE[doc] = "The maximum allowable size in kilobytes of the kernel image file." + + + + Specifies the maximum size of the kernel image file in + kilobytes. + If KERNEL_IMAGE_MAXSIZE is set, + the size of the kernel image file is checked against + the set value during the + do_sizecheck + task. + The task fails if the kernel image file is larger than + the setting. + + + + KERNEL_IMAGE_MAXSIZE is useful for + target devices that have a limited amount of space in + which the kernel image file must be stored. + + + + By default, this variable is not set, which means the + size of the kernel image is not checked. + + + + KERNEL_IMAGETYPE KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'." @@ -7064,6 +7267,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + PACKAGEGROUP_DISABLE_COMPLEMENTARY + + PACKAGEGROUP_DISABLE_COMPLEMENTARY[doc] = "Prevents the packagegroup recipe from automatically creating the normal complementary packages such as -dev and -dbg." + + + + For recipes inheriting the + packagegroup + class, setting + PACKAGEGROUP_DISABLE_COMPLEMENTARY to + "1" specifies that the normal complementary packages + (i.e. -dev, + -dbg, and so forth) should not be + automatically created by the + packagegroup recipe, which is the + default behavior. + + + + PACKAGES PACKAGES[doc] = "The list of packages to be created from the recipe." @@ -10107,6 +10330,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + TCLIBCAPPEND + + TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build." + + + + Specifies a suffix to be appended onto the + TMPDIR + value. + The suffix identifies the libc variant + for building. + + + + In the defaultsetup.conf file, the + default value of TCLIBCAPPEND is + "-${TCLIBC}". + However, distros such as poky, which normally only support + one libc variant, set + TCLIBCAPPEND to "" in their distro + configuration file resulting in no suffix being applied. + + + + TCLIBC TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc' or 'uclibc'." @@ -11080,6 +11328,28 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + UPDATERCPN + + UPDATERCPN[doc] = "Specifies the package that contains the initscript that is to be enabled." + + + + For recipes inheriting the + update-rc.d + class, UPDATERCPN specifies + the package that contains the initscript that is to be + enabled. + + + + The default value is "${PN}". + Given that almost all recipes that install initscripts + package them in the main package for the recipe, you + rarely need to set this variable in individual recipes. + + + + UBOOT_ENTRYPOINT UBOOT_ENTRYPOINT[doc] = "Specifies the entry point for the U-Boot image."