meta/conf/documentation.conf

3 # Mail your changes to openembedded-devel@openembedded.org
8 do_build[doc] = "Default task for a recipe - depends on all other normal tasks required to 'build' …
17 do_configure[doc] = "Configures the source by enabling and disabling any build-time and configurati…
26 do_kernel_checkout[doc] = "Checks out source/meta branches for a linux-yocto style kernel"
27 do_kernel_configcheck[doc] = "Validates the kernel configuration for a linux-yocto style kernel"
28 do_kernel_configme[doc] = "Assembles the kernel configuration for a linux-yocto style kernel"
45 do_rm_work_all[doc] = "Top-level task for removing work files after the build system has finished w…
54 do_uboot_mkimage[doc] = "Creates a uImage file from the kernel for the U-Boot bootloader"
56 …meta branches are on the locations specified by their SRCREV values for a linux-yocto style kernel"
95 BBSERVER[doc] = "Points to the server that runs memory-resident BitBake."
97 …t without any special recipe name suffix (i.e. -native, lib64-, and so forth). BP is comprised of …
110 … the special class override that should currently apply (e.g. "class-target", "class-native", and …
113 COMMON_LICENSE_DIR[doc] = "Points to meta/files/common-licenses in the Source Directory, which is w…
114 …s (when the recipe is native) or one or more targets (when the recipe is non-native) with which a …
125 CVE_CHECK_LAYER_EXCLUDELIST[doc] = "Defines which layers to exclude from cve-check scanning"
126 CVE_CHECK_LAYER_INCLUDELIST[doc] = "Defines which layers to include during cve-check scanning"
134 …FLAGS when compiling a system for debugging. This variable defaults to '-Og ${DEBUG_FLAGS} -pipe'."
136 DEPENDS[doc] = "Lists a recipe's build-time dependencies (i.e. other recipe files)."
142 …cifies a list of distro-specific packages to add to all images. The variable only applies to the i…
143 DISTRO_EXTRA_RRECOMMENDS[doc] = "Specifies a list of distro-specific packages to add to all images …
145 …variable is set in the meta/conf/bitbake.conf file and it is not intended to be user-configurable."
178 …ase.bbclass class found in meta/classes in the Source Directory. Do not hand-edit the FILESPATH va…
180 …le specifies runtime dependencies for font packages. This variable defaults to 'fontconfig-utils'."
182 …and CFLAGS when compiling an optimized system. This variable defaults to '-O2 -pipe ${DEBUG_FLAGS}…
191 GTKIMMODULES_PACKAGES[doc] = "For recipes that inherit the gtk-immodules-cache class, this variable…
205 ICECC_ENV_EXEC[doc] = "Points to the icecc-create-env script that you provide."
211 …To change the destination file name, pass a desired name after a semicolon (eg. u-boot.img;uboot)."
228 …pace-separated list of license names (as they would appear in LICENSE) that should be excluded fro…
236 …that contain initscripts. This variable is used in recipes when using update-rc.d.bbclass. The var…
237 …Specifies the options to pass to update-rc.d. The variable is mandatory and is used in recipes whe…
247 KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build s…
251 KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded during boot"
272 …cit encoding (e.g. en_US) will always be UTF-8, and non-UTF-8 encodings are renamed to, e.g., en_U…
278 MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as…
279 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to inst…
280 …-specific packages to install as part of the image being built that are not essential for the mach…
281 MACHINE_EXTRA_RRECOMMENDS[doc] = "A list of machine-specific packages to install as part of the ima…
283 …is variable is set in the meta/conf/bitbake.conf file and is not intended to be user-configurable."
289 MODULE_TARBALL_DEPLOY[doc] = "Controls creation of the modules-*.tgz file. Set this variable to "0"…
295 … packages might be required for certain system functionality, such as kernel-modules. It is up to …
302 OEROOT[doc] = "The directory from which the top-level build environment setup script is sourced."
308 P[doc] = "The recipe name and version. P is comprised of ${PN}-${PV}."
315 … packages to be installed into the image. The variable is generally not user-defined and uses IMAG…
316 …install, the build system does not generate an error. This variable is generally not user-defined."
317 …id an extra layer of indirection through a symlink. Only suitable for a read-only rootfs where lib…
318 …his variable provides a means of enabling or disabling features of a recipe on a per-recipe basis."
321 …make command during the compile tasks. This variable is usually in the form -j 4, where the number…
326 …udes all version and revision numbers. This variable is comprised of ${PN}-${EXTENDPE}${PV}-${PR}."
327 …che class, this variable identifies packages that contain the pixbuf loaders used with gdk-pixbuf."
329 PKGDATA_DIR[doc] = "Points to a shared, global-state directory that holds data generated during the…
375 …iable applies to the SDK generated from an image using the command 'bitbake -c populate_sdk imagen…
385 …f the target system. The value should be either 'le' for 'little-endian' or 'be' for 'big-endian'."
393 SRC_URI[doc] = "The list of source files - local or remote. This variable tells the OpenEmbedded bu…
394 …system automatically detects whether SRC_URI contains files that are machine-specific. If so, the …
400 STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree…
418 …. The OpenEmbedded build system supports the following architectures: arm, mips, ppc, x86, x86-64."
420 TARGET_FPU[doc] = "Specifies the method for handling FPU code. For FPU-less targets, which include …
422 TARGET_PREFIX[doc] = "The prefix for the cross-compile toolchain (e.g. arm-linux-)."
437 … OpenEmbedded build system uses when building an SDK, which contains a cross-development environme…
448 UBOOT_ENTRYPOINT[doc] = "Specifies the entry point for the U-Boot image."
449 UBOOT_LOADADDRESS[doc] = "Specifies the load address for the U-Boot image."
450 UBOOT_LOCALVERSION[doc] = "Appends a string to the name of the local version of the U-Boot image."
451 UBOOT_MACHINE[doc] = "Specifies the value passed on the make command line when building a U-Boot im…
453 UBOOT_SUFFIX[doc] = "Points to the generated U-Boot extension."
454 UBOOT_TARGET[doc] = "Specifies the target used for building U-Boot."
462 USERADDEXTENSION[doc] = "When set to 'useradd-staticids', causes the OpenEmbedded build system to b…