diff options
Diffstat (limited to 'poky/documentation/ref-manual')
| -rw-r--r-- | poky/documentation/ref-manual/classes.rst | 50 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/devtool-reference.rst | 8 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/examples/hello-single/hello.bb | 2 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/faq.rst | 6 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/images.rst | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/kickstart.rst | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/migration-1.7.rst | 2 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/migration-2.1.rst | 2 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/migration-2.2.rst | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/migration-2.3.rst | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/migration-2.7.rst | 2 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/qa-checks.rst | 2 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/release-process.rst | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/resources.rst | 7 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/system-requirements.rst | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/terms.rst | 7 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/variables.rst | 95 |
17 files changed, 133 insertions, 74 deletions
diff --git a/poky/documentation/ref-manual/classes.rst b/poky/documentation/ref-manual/classes.rst index 5a30ce379..be112e0fa 100644 --- a/poky/documentation/ref-manual/classes.rst +++ b/poky/documentation/ref-manual/classes.rst @@ -278,7 +278,7 @@ The ``ccache`` class enables the C/C++ Compiler Cache for the build. This class is used to give a minor performance boost during the build. However, using the class can lead to unexpected side-effects. Thus, it is recommended that you do not use this class. See -http://ccache.samba.org/ for information on the C/C++ Compiler +https://ccache.samba.org/ for information on the C/C++ Compiler Cache. .. _ref-classes-chrpath: @@ -931,7 +931,7 @@ For information on customizing images, see the in the Yocto Project Development Tasks Manual. For information on how images are created, see the ":ref:`overview-manual/concepts:images`" section in the -Yocto Project Overview and Concpets Manual. +Yocto Project Overview and Concepts Manual. .. _ref-classes-image-buildinfo: @@ -1374,39 +1374,61 @@ generation. ``kernel-fitimage.bbclass`` =========================== -The ``kernel-fitimage`` class provides support to pack a kernel Image, -device trees and a RAM disk into a single FIT image. In theory, a FIT -image can support any number of kernels, RAM disks and device-trees. +The ``kernel-fitimage`` class provides support to pack a kernel image, +device trees, a U-boot script, a Initramfs bundle and a RAM disk +into a single FIT image. In theory, a FIT image can support any number +of kernels, U-boot scripts, Initramfs bundles, RAM disks and device-trees. However, ``kernel-fitimage`` currently only supports -limited usescases: just one kernel image, an optional RAM disk, and -any number of device tree. +limited usescases: just one kernel image, an optional U-boot script, +an optional Initramfs bundle, an optional RAM disk, and any number of +device tree. To create a FIT image, it is required that :term:`KERNEL_CLASSES` -is set to "kernel-fitimage" and :term:`KERNEL_IMAGETYPE` +is set to include "kernel-fitimage" and :term:`KERNEL_IMAGETYPE` is set to "fitImage". -The options for the device tree compiler passed to mkimage -D feature +The options for the device tree compiler passed to ``mkimage -D`` when creating the FIT image are specified using the :term:`UBOOT_MKIMAGE_DTCOPTS` variable. Only a single kernel can be added to the FIT image created by ``kernel-fitimage`` and the kernel image in FIT is mandatory. The -address where the kernel image is to be loaded by U-boot is +address where the kernel image is to be loaded by U-Boot is specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. Multiple device trees can be added to the FIT image created by ``kernel-fitimage`` and the device tree is optional. -The address where the device tree is to be loaded by U-boot is +The address where the device tree is to be loaded by U-Boot is specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries. Only a single RAM disk can be added to the FIT image created by ``kernel-fitimage`` and the RAM disk in FIT is optional. -The address where the RAM disk image is to be loaded by U-boot +The address where the RAM disk image is to be loaded by U-Boot is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by :term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to FIT image when -:term:`INITRAMFS_IMAGE` is specified. +:term:`INITRAMFS_IMAGE` is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` +is set to 0. + +Only a single Initramfs bundle can be added to the FIT image created by +``kernel-fitimage`` and the Initramfs bundle in FIT is optional. +In case of Initramfs, the kernel is configured to be bundled with the rootfs +in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). +When the kernel is copied to RAM and executed, it unpacks the Initramfs rootfs. +The Initramfs bundle can be enabled when :term:`INITRAMFS_IMAGE` +is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. +The address where the Initramfs bundle is to be loaded by U-boot is specified +by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. + +Only a single U-boot boot script can be added to the FIT image created by +``kernel-fitimage`` and the boot script is optional. +The boot script is specified in the ITS file as a text file containing +U-boot commands. When using a boot script the user should configure the +U-boot ``do_install`` task to copy the script to sysroot. +So the script can be included in the the FIT image by the ``kernel-fitimage`` +class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to +load the boot script from the FIT image and executes it. The FIT image generated by ``kernel-fitimage`` class is signed when the variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, @@ -2581,7 +2603,7 @@ the :term:`SYSTEMD_BOOT_CFG`, :term:`SYSTEMD_BOOT_TIMEOUT` variables. You can also see the `Systemd-boot -documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__ +documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__ for more information. .. _ref-classes-terminal: diff --git a/poky/documentation/ref-manual/devtool-reference.rst b/poky/documentation/ref-manual/devtool-reference.rst index cc5848fd4..5075f0c22 100644 --- a/poky/documentation/ref-manual/devtool-reference.rst +++ b/poky/documentation/ref-manual/devtool-reference.rst @@ -204,20 +204,20 @@ specify these options when using the ``devtool add`` command: - To specify a source branch, use the ``--srcbranch`` option: :: - $ devtool add --srcbranch DISTRO_NAME_NO_CAP jackson /home/user/sources/jackson + $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/user/sources/jackson - In the previous example, you are checking out the DISTRO_NAME_NO_CAP + In the previous example, you are checking out the &DISTRO_NAME_NO_CAP; branch. - To specify a specific tag or commit hash, use the ``--srcrev`` option: :: - $ devtool add --srcrev DISTRO_REL_TAG jackson /home/user/sources/jackson + $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/user/sources/jackson $ devtool add --srcrev some_commit_hash /home/user/sources/jackson The previous examples check out the - DISTRO_REL_TAG tag and the commit associated with the + &DISTRO_REL_TAG; tag and the commit associated with the some_commit_hash hash. .. note:: diff --git a/poky/documentation/ref-manual/examples/hello-single/hello.bb b/poky/documentation/ref-manual/examples/hello-single/hello.bb index 0812743e3..90d3aefd8 100644 --- a/poky/documentation/ref-manual/examples/hello-single/hello.bb +++ b/poky/documentation/ref-manual/examples/hello-single/hello.bb @@ -8,7 +8,7 @@ SRC_URI = "file://helloworld.c" S = "${WORKDIR}" do_compile() { - ${CC} helloworld.c -o helloworld + ${CC} ${LDFLAGS} helloworld.c -o helloworld } do_install() { diff --git a/poky/documentation/ref-manual/faq.rst b/poky/documentation/ref-manual/faq.rst index f67c53824..34b26ee3e 100644 --- a/poky/documentation/ref-manual/faq.rst +++ b/poky/documentation/ref-manual/faq.rst @@ -55,9 +55,9 @@ Yocto Project is fairly straightforward. **Q:** Are there any products built using the OpenEmbedded build system? **A:** The software running on the `Vernier -LabQuest <http://vernier.com/labquest/>`__ is built using the +LabQuest <https://vernier.com/labquest/>`__ is built using the OpenEmbedded build system. See the `Vernier -LabQuest <http://www.vernier.com/products/interfaces/labq/>`__ website +LabQuest <https://www.vernier.com/products/interfaces/labq/>`__ website for more information. There are a number of pre-production devices using the OpenEmbedded build system and the Yocto Project team announces them as soon as they are released. @@ -273,7 +273,7 @@ OpenEmbedded build system to use its internally built toolchain (i.e. particular, "external-\*" refers to external toolchains. One example is the Sourcery G++ Toolchain. The support for this toolchain resides in the separate ``meta-sourcery`` layer at -http://github.com/MentorEmbedded/meta-sourcery/. +https://github.com/MentorEmbedded/meta-sourcery/. In addition to the toolchain configuration, you also need a corresponding toolchain recipe file. This recipe file needs to package diff --git a/poky/documentation/ref-manual/images.rst b/poky/documentation/ref-manual/images.rst index 5e9374eae..cf5cc1109 100644 --- a/poky/documentation/ref-manual/images.rst +++ b/poky/documentation/ref-manual/images.rst @@ -37,9 +37,9 @@ Following is a list of supported recipes: all the pieces required to run builds using the build system as well as the build system itself. You can boot and run the image using either the `VMware - Player <http://www.vmware.com/products/player/overview.html>`__ or + Player <https://www.vmware.com/products/player/overview.html>`__ or `VMware - Workstation <http://www.vmware.com/products/workstation/overview.html>`__. + Workstation <https://www.vmware.com/products/workstation/overview.html>`__. For more information on this image, see the :yocto_home:`Build Appliance </software-item/build-appliance>` page on the Yocto Project website. diff --git a/poky/documentation/ref-manual/kickstart.rst b/poky/documentation/ref-manual/kickstart.rst index bb9c0460f..472820f16 100644 --- a/poky/documentation/ref-manual/kickstart.rst +++ b/poky/documentation/ref-manual/kickstart.rst @@ -24,7 +24,7 @@ The information lists the commands, their syntax, and meanings. Kickstart commands are based on the Fedora kickstart versions but with modifications to reflect Wic capabilities. You can see the original documentation for those commands at the following link: -http://pykickstart.readthedocs.io/en/latest/kickstart-docs.html +https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html Command: part or partition ========================== @@ -164,7 +164,7 @@ the ``part`` and ``partition`` commands: - ``--part-type``: This option is a Wic-specific option that specifies the partition type globally unique identifier (GUID) for GPT partitions. You can find the list of partition type GUIDs at - http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. + https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. - ``--use-uuid``: This option is a Wic-specific option that causes Wic to generate a random GUID for the partition. The generated diff --git a/poky/documentation/ref-manual/migration-1.7.rst b/poky/documentation/ref-manual/migration-1.7.rst index 19275b3cd..54544e479 100644 --- a/poky/documentation/ref-manual/migration-1.7.rst +++ b/poky/documentation/ref-manual/migration-1.7.rst @@ -190,7 +190,7 @@ Removed Recipes The following recipes have been removed: -- ``x-load``: This recipe has been superseded by U-boot SPL for all +- ``x-load``: This recipe has been superseded by U-Boot SPL for all Cortex-based TI SoCs. For legacy boards, the ``meta-ti`` layer, which contains a maintained recipe, should be used instead. diff --git a/poky/documentation/ref-manual/migration-2.1.rst b/poky/documentation/ref-manual/migration-2.1.rst index e8b3ada26..861d04861 100644 --- a/poky/documentation/ref-manual/migration-2.1.rst +++ b/poky/documentation/ref-manual/migration-2.1.rst @@ -89,7 +89,7 @@ package-specific nesting should be done by the package itself. Finally, having ``libexecdir`` change between recipes makes it very difficult for different recipes to invoke binaries that have been installed into ``libexecdir``. The Filesystem Hierarchy Standard (i.e. -http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now +https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now recognizes the use of ``${prefix}/libexec/``, giving distributions the choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without breaking FHS. diff --git a/poky/documentation/ref-manual/migration-2.2.rst b/poky/documentation/ref-manual/migration-2.2.rst index ac247dce4..5c6fecf32 100644 --- a/poky/documentation/ref-manual/migration-2.2.rst +++ b/poky/documentation/ref-manual/migration-2.2.rst @@ -28,8 +28,8 @@ The way directories are staged in sysroot has been simplified and introduces the new :term:`SYSROOT_DIRS`, :term:`SYSROOT_DIRS_NATIVE`, and :term:`SYSROOT_DIRS_BLACKLIST`. See the -`v2 patch series on the OE-Core Mailing -List <http://lists.openembedded.org/pipermail/openembedded-core/2016-May/121365.html>`__ +:oe_lists:`v2 patch series on the OE-Core Mailing List +</pipermail/openembedded-core/2016-May/121365.html>` for additional information. .. _migration-2.2-removal-of-old-images-from-tmp-deploy-now-enabled: diff --git a/poky/documentation/ref-manual/migration-2.3.rst b/poky/documentation/ref-manual/migration-2.3.rst index 3e9758119..04b11daa7 100644 --- a/poky/documentation/ref-manual/migration-2.3.rst +++ b/poky/documentation/ref-manual/migration-2.3.rst @@ -238,7 +238,7 @@ to substitute a GPLv2 version of a GPLv3 recipe, then you must add the .. note:: You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at - https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/. + :oe_layer:`/meta-gplv2`. These relocated GPLv2 recipes do not receive the same level of maintenance as other core recipes. The recipes do not get security fixes @@ -274,7 +274,7 @@ The following package management changes took place: fixed. For more information, see the `DNF - Documentation <http://dnf.readthedocs.io/en/latest/>`__. + Documentation <https://dnf.readthedocs.io/en/latest/>`__. - Rpm 5.x is replaced with Rpm 4.x. This is done for two major reasons: diff --git a/poky/documentation/ref-manual/migration-2.7.rst b/poky/documentation/ref-manual/migration-2.7.rst index 7e628fc3e..5af5947ff 100644 --- a/poky/documentation/ref-manual/migration-2.7.rst +++ b/poky/documentation/ref-manual/migration-2.7.rst @@ -159,7 +159,7 @@ The following miscellaneous changes occurred: from the top-level ``scripts`` directory. - Perl now builds for the target using - `perl-cross <http://arsv.github.io/perl-cross/>`_ for better + `perl-cross <https://arsv.github.io/perl-cross/>`_ for better maintainability and improved build performance. This change should not present any problems unless you have heavily customized your Perl recipe. diff --git a/poky/documentation/ref-manual/qa-checks.rst b/poky/documentation/ref-manual/qa-checks.rst index 54977dcb2..6cb767d93 100644 --- a/poky/documentation/ref-manual/qa-checks.rst +++ b/poky/documentation/ref-manual/qa-checks.rst @@ -227,7 +227,7 @@ Errors and Warnings CFLAGS_append = " -fPIC " For more information on text relocations at runtime, see - http://www.akkadia.org/drepper/textrelocs.html. + https://www.akkadia.org/drepper/textrelocs.html. .. _qa-check-ldflags: diff --git a/poky/documentation/ref-manual/release-process.rst b/poky/documentation/ref-manual/release-process.rst index d8d362282..ed5a09a55 100644 --- a/poky/documentation/ref-manual/release-process.rst +++ b/poky/documentation/ref-manual/release-process.rst @@ -12,7 +12,7 @@ stability. Major and Minor Release Cadence =============================== -The Yocto Project delivers major releases (e.g. DISTRO) using a six +The Yocto Project delivers major releases (e.g. &DISTRO;) using a six month cadence roughly timed each April and October of the year. Following are examples of some major YP releases with their codenames also shown. See the "`Major Release @@ -57,7 +57,7 @@ codename are likely to be compatible and thus work together. .. note:: Codenames are associated with major releases because a Yocto Project - release number (e.g. DISTRO) could conflict with a given layer or + release number (e.g. &DISTRO;) could conflict with a given layer or company versioning scheme. Codenames are unique, interesting, and easily identifiable. diff --git a/poky/documentation/ref-manual/resources.rst b/poky/documentation/ref-manual/resources.rst index 77c367809..7554164d1 100644 --- a/poky/documentation/ref-manual/resources.rst +++ b/poky/documentation/ref-manual/resources.rst @@ -52,7 +52,7 @@ against the Yocto Project, see the following: - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` -For information on Bugzilla in general, see http://www.bugzilla.org/about/. +For information on Bugzilla in general, see https://www.bugzilla.org/about/. .. _resources-mailinglist: @@ -118,8 +118,7 @@ Here is a list of resources you might find helpful: distribution from which the Yocto Project derives its build system (Poky) and to which it contributes. -- :oe_home:`BitBake </wiki/BitBake>`\ *:* The tool - used to process metadata. +- :oe_wiki:`BitBake </BitBake>`\ *:* The tool used to process metadata. - :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive guide to the BitBake tool. If you want information on BitBake, see @@ -194,5 +193,5 @@ Here is a list of resources you might find helpful: available for Yocto Project and Poky discussions: ``#yocto`` and ``#poky``, respectively. -- `Quick EMUlator (QEMU) <http://wiki.qemu.org/Index.html>`__\ *:* An +- `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__\ *:* An open-source machine emulator and virtualizer. diff --git a/poky/documentation/ref-manual/system-requirements.rst b/poky/documentation/ref-manual/system-requirements.rst index 66afb0810..c8c1381cb 100644 --- a/poky/documentation/ref-manual/system-requirements.rst +++ b/poky/documentation/ref-manual/system-requirements.rst @@ -340,12 +340,12 @@ of the two methods by which you can get these tools: traditional installer: :: - $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh + $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh Here is an example for the extended installer: :: - $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh + $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh During execution, a prompt appears that allows you to choose the installation directory. For example, you could choose the following: diff --git a/poky/documentation/ref-manual/terms.rst b/poky/documentation/ref-manual/terms.rst index c07dd4b12..bf4614887 100644 --- a/poky/documentation/ref-manual/terms.rst +++ b/poky/documentation/ref-manual/terms.rst @@ -90,13 +90,13 @@ universal, the list includes them just in case: - Provide a directory path and specifically name the Build Directory. Any intermediate folders in the pathname must exist. This next example creates a Build Directory named - ``YP-POKYVERSION`` in your home directory within the existing + ``YP-&POKYVERSION;`` in your home directory within the existing directory ``mybuilds``: .. code-block:: shell $ cd $HOME - $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-POKYVERSION + $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-&POKYVERSION; .. note:: @@ -349,7 +349,8 @@ universal, the list includes them just in case: Source Directory is derived from the Yocto Project release tarball. For example, downloading and unpacking :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2` - results in a Source Directory whose root folder is named ``poky``. + results in a Source Directory whose root folder is named + ``&YOCTO_POKY;``. It is important to understand the differences between the Source Directory created by unpacking a released tarball as compared to diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst index 8c6cc46b6..2cb37b6a2 100644 --- a/poky/documentation/ref-manual/variables.rst +++ b/poky/documentation/ref-manual/variables.rst @@ -2538,6 +2538,13 @@ system and gives an overview of their function and contents. For guidance on how to create your own file permissions settings table file, examine the existing ``fs-perms.txt``. + :term:`FIT_DESC` + Specifies the description string encoded into a fitImage. The default + value is set by the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` + class as follows:: + + FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" + :term:`FIT_GENERATE_KEYS` Decides whether to generate the keys for signing fitImage if they don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. @@ -2568,6 +2575,13 @@ system and gives an overview of their function and contents. Size of private key in number of bits used in fitImage. The default value is "2048". + :term:`FIT_SIGN_INDIVIDUAL` + If set to "1", then the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` + class will sign the kernel, dtb and ramdisk images individually in addition + to signing the fitImage itself. This could be useful if you are + intending to verify signatures in another context than booting via + U-Boot. + :term:`FONT_EXTRA_RDEPENDS` When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, this variable specifies the runtime dependencies for font packages. @@ -2648,7 +2662,7 @@ system and gives an overview of their function and contents. GROUPADD_PARAM_${PN} = "-r netdev" For information on the standard Linux shell command - ``groupadd``, see http://linux.die.net/man/8/groupadd. + ``groupadd``, see https://linux.die.net/man/8/groupadd. :term:`GROUPMEMS_PARAM` When inheriting the :ref:`useradd <ref-classes-useradd>` class, @@ -2657,7 +2671,7 @@ system and gives an overview of their function and contents. of a group when the package is installed. For information on the standard Linux shell command ``groupmems``, - see http://linux.die.net/man/8/groupmems. + see https://linux.die.net/man/8/groupmems. :term:`GRUB_GFXSERIAL` Configures the GNU GRand Unified Bootloader (GRUB) to have graphics @@ -3870,6 +3884,15 @@ system and gives an overview of their function and contents. KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + :term:`KERNEL_DTC_FLAGS` + Specifies the ``dtc`` flags that are passed to the Linux kernel build + system when generating the device trees (via ``DTC_FLAGS`` environment + variable). + + In order to use this variable, the + :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must + be inherited. + :term:`KERNEL_EXTRA_ARGS` Specifies additional ``make`` command-line arguments the OpenEmbedded build system passes on when compiling the kernel. @@ -3983,8 +4006,9 @@ system and gives an overview of their function and contents. when building the kernel and is passed to ``make`` as the target to build. - If you want to build an alternate kernel image type, use the - :term:`KERNEL_ALT_IMAGETYPE` variable. + If you want to build an alternate kernel image type in addition to that + specified by ``KERNEL_IMAGETYPE``, use the :term:`KERNEL_ALT_IMAGETYPE` + variable. :term:`KERNEL_MODULE_AUTOLOAD` Lists kernel modules that need to be auto-loaded during boot. @@ -4178,11 +4202,11 @@ system and gives an overview of their function and contents. this variable in your layer's ``conf/layer.conf`` configuration file. For the list, use the Yocto Project :yocto_wiki:`Release Name </Releases>` (e.g. - DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the + &DISTRO_NAME_NO_CAP;). To specify multiple OE-Core versions for the layer, use a space-separated list: :: - LAYERSERIES_COMPAT_layer_root_name = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE" + LAYERSERIES_COMPAT_layer_root_name = "&DISTRO_NAME_NO_CAP; &DISTRO_NAME_NO_CAP_MINUS_ONE;" .. note:: @@ -4679,7 +4703,7 @@ system and gives an overview of their function and contents. See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. module_conf - Specifies `modprobe.d <http://linux.die.net/man/5/modprobe.d>`_ + Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`_ syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` file. @@ -5891,23 +5915,16 @@ system and gives an overview of their function and contents. file ``eudev_3.2.9.bb``: :: - PROVIDES = "udev" + PROVIDES += "udev" The ``PROVIDES`` statement results in the "eudev" recipe also being available as simply "udev". .. note:: - Given that a recipe's own recipe name is already implicitly in its - own PROVIDES list, it is unnecessary to add aliases with the "+=" operator; - using a simple assignment will be sufficient. In other words, - while you could write: - :: - - PROVIDES += "udev" - - - in the above, the "+=" is overkill and unnecessary. + A recipe's own recipe name (:term:`PN`) is always implicitly prepended + to `PROVIDES`, so while using "+=" in the above example may not be + strictly necessary it is recommended to avoid confusion. In addition to providing recipes under alternate names, the ``PROVIDES`` mechanism is also used to implement virtual targets. A @@ -7604,7 +7621,7 @@ system and gives an overview of their function and contents. SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" For information on Systemd-boot, see the `Systemd-boot - documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. + documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. :term:`SYSTEMD_BOOT_ENTRIES` When :term:`EFI_PROVIDER` is set to @@ -7618,7 +7635,7 @@ system and gives an overview of their function and contents. SYSTEMD_BOOT_ENTRIES ?= "" For information on Systemd-boot, see the `Systemd-boot - documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. + documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. :term:`SYSTEMD_BOOT_TIMEOUT` When :term:`EFI_PROVIDER` is set to @@ -7631,7 +7648,7 @@ system and gives an overview of their function and contents. SYSTEMD_BOOT_TIMEOUT ?= "10" For information on Systemd-boot, see the `Systemd-boot - documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. + documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. :term:`SYSTEMD_PACKAGES` When inheriting the :ref:`systemd <ref-classes-systemd>` class, @@ -7662,7 +7679,7 @@ system and gives an overview of their function and contents. When using :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`, specifies a space-separated list of the virtual terminals that should - run a `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ + run a `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ (allowing login), assuming :term:`USE_VT` is not set to "0". @@ -7886,7 +7903,7 @@ system and gives an overview of their function and contents. toolchain. One example is the Sourcery G++ Toolchain. The support for this toolchain resides in the separate Mentor Graphics ``meta-sourcery`` layer at - http://github.com/MentorEmbedded/meta-sourcery/. + https://github.com/MentorEmbedded/meta-sourcery/. The layer's ``README`` file contains information on how to use the Sourcery G++ Toolchain as an external toolchain. In summary, you must @@ -8389,21 +8406,21 @@ system and gives an overview of their function and contents. In this example, "sd" is selected as the configuration of the possible four for the ``UBOOT_MACHINE``. The "sd" configuration defines "mx6qsabreauto_config" as the value for ``UBOOT_MACHINE``, while the - "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-boot image. + "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-Boot image. For more information on how the ``UBOOT_CONFIG`` is handled, see the :ref:`uboot-config <ref-classes-uboot-config>` class. :term:`UBOOT_DTB_LOADADDRESS` - Specifies the load address for the dtb image used by U-boot. During FIT + Specifies the load address for the dtb image used by U-Boot. During FIT image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in creating the dtb sections of Image Tree Source for the FIT image. :term:`UBOOT_DTBO_LOADADDRESS` - Specifies the load address for the dtbo image used by U-boot. During FIT + Specifies the load address for the dtbo image used by U-Boot. During FIT image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in creating the dtbo sections of Image Tree Source for the FIT image. @@ -8440,9 +8457,29 @@ system and gives an overview of their function and contents. Specifies the target called in the ``Makefile``. The default target is "all". + :term:`UBOOT_MKIMAGE` + Specifies the name of the mkimage command as used by the + :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to assemble + the FIT image. This can be used to substitute an alternative command, wrapper + script or function if desired. The default is "uboot-mkimage". + :term:`UBOOT_MKIMAGE_DTCOPTS` Options for the device tree compiler passed to mkimage '-D' feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. + If ``UBOOT_MKIMAGE_DTCOPTS`` is not set then kernel-fitimage will not + pass the ``-D`` option to mkimage. + + :term:`UBOOT_MKIMAGE_SIGN` + Specifies the name of the mkimage command as used by the + :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to sign + the FIT image after it has been assembled (if enabled). This can be used + to substitute an alternative command, wrapper script or function if + desired. The default is "${:term:`UBOOT_MKIMAGE`}". + + :term:`UBOOT_MKIMAGE_SIGN_ARGS` + Optionally specifies additional arguments for the + :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to pass to the + mkimage command when signing the FIT image. :term:`UBOOT_RD_ENTRYPOINT` Specifies the entrypoint for the RAM disk image. @@ -8468,7 +8505,7 @@ system and gives an overview of their function and contents. certificate used for signing FIT image. :term:`UBOOT_SIGN_KEYNAME` - The name of keys used for signing U-boot FIT image stored in + The name of keys used for signing U-Boot FIT image stored in :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have :term:`UBOOT_SIGN_KEYNAME` set to "dev". @@ -8562,7 +8599,7 @@ system and gives an overview of their function and contents. When using :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`, determines whether or not to run a - `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any + `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any virtual terminals in order to enable logging in through those terminals. @@ -8673,7 +8710,7 @@ system and gives an overview of their function and contents. For information on the standard Linux shell command ``useradd``, see - http://linux.die.net/man/8/useradd. + https://linux.die.net/man/8/useradd. :term:`USERADD_UID_TABLES` Specifies a password file to use for obtaining static user |