Yocto Project

https://docs.yoctoproject.org/
Admin
The Yocto Project is an open-source collaboration that provides tools and methodologies to create...
Tokens:1,127,472
Snippets:17,716
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example: Start Builds for Two Multiconfigs

Source: https://docs.yoctoproject.org/bitbake/1.50/_sources/bitbake-user-manual/bitbake-user-manual-intro.rst.txt

An example command to start builds for two extra multiconfigs, 'target1' and 'target2'.

```bash
$ bitbake mc::target mc:target1:target mc:target2:target
```

--------------------------------

### Running the SDK Installer

Source: https://docs.yoctoproject.org/_sources/sdk-manual/appendix-obtain.rst.txt

Example command to execute the downloaded SDK installer script from the Downloads directory.

```console
$ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
```

--------------------------------

### Example SDK Installer Filename

Source: https://docs.yoctoproject.org/_sources/sdk-manual/extensible.rst.txt

This is an example of an SDK installer filename, indicating the target architecture and distribution version.

```text
poky-glibc-x86_64-core-image-sato-i586-toolchain-ext-&DISTRO;.sh
```

--------------------------------

### Example SDK Installer Filename

Source: https://docs.yoctoproject.org/_sources/sdk-manual/appendix-obtain.rst.txt

An example of a specific SDK installer filename for a 64-bit x86 build host and a 64-bit core2 QEMU target.

```text
poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
```

--------------------------------

### Run SDK Installer

Source: https://docs.yoctoproject.org/sdk-manual/appendix-obtain.html

Example commands to navigate to the deployment directory and execute the generated SDK installer script.

```bash
$ cd bitbake-builds/build/tmp/deploy/sdk
$ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-6.0.1.sh
```

--------------------------------

### Standard SDK Installer Filename Example

Source: https://docs.yoctoproject.org/_sources/sdk-manual/using.rst.txt

This is an example of the naming convention for a Standard SDK tarball installer script.

```text
poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
```

--------------------------------

### Running the Standard SDK Installer

Source: https://docs.yoctoproject.org/_sources/sdk-manual/using.rst.txt

This command shows how to execute the SDK installer script. Ensure the script has execution rights and is located in the specified path. The installer prompts for the installation directory and confirms the setup.

```console
$ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
Poky (Yocto Project Reference Distro) SDK installer version &DISTRO;
===============================================================
Enter target directory for SDK (default: /opt/poky/&DISTRO;):
You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed [Y/n]? Y
Extracting SDK........................................ ..............................done
Setting it up...done
SDK has been successfully set up and is ready to be used.
Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
 $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
```

--------------------------------

### Initialize Setup with Custom Settings and Source Overrides

Source: https://docs.yoctoproject.org/bitbake/2.16/_sources/bitbake-user-manual/bitbake-user-manual-environment-setup.rst.txt

This example demonstrates initializing a Setup non-interactively with custom top directory settings, a source override file, a standalone generic configuration, and specific choices passed on the command line.

```shell
$ ./bitbake/bin/bitbake-setup \
    --setting default top-dir-prefix /work/bitbake-setup \
    --setting default top-dir-name custom-project \
    init \
    --non-interactive \
    --source-overrides develop-branch.json \
    ./gadget_master.conf.json \
    gadget distro/gadget machine/gadget
```

--------------------------------

### Select configuration interactively

Source: https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html

Example output showing the selection of a configuration, target machine, and distribution during the interactive setup process.

```text
Available configurations:
1. poky-master  Poky - The Yocto Project testing distribution configurations and hardware test platforms
2. oe-nodistro-wrynose       OpenEmbedded - 'nodistro' basic configuration, release 6.0 'wrynose'
3. poky-wrynose      Poky - The Yocto Project testing distribution configurations and hardware test platforms, release 6.0 'wrynose'
4. oe-nodistro-master   OpenEmbedded - 'nodistro' basic configuration
...

Please select one of the above configurations by its number:
1
```

```text
Available bitbake configurations:
1. poky Poky - The Yocto Project testing distribution
2. poky-with-sstate     Poky - The Yocto Project testing distribution with internet sstate acceleration. Use with caution as it requires a completely robust local network with sufficient bandwidth.

Please select one of the above bitbake configurations by its number:
1
```

```text
Target machines:
1. machine/qemux86-64
2. machine/qemuarm64
3. machine/qemuriscv64
4. machine/genericarm64
5. machine/genericx86-64

Please select one of the above options by its number:
1
```

```text
Distribution configuration variants:
1. distro/poky
2. distro/poky-altcfg
3. distro/poky-tiny

Please select one of the above options by its number:
1
```

```text
Enter setup directory name: [poky-master-poky-distro_poky-machine_qemux86-64]
```

--------------------------------

### Example Recipe Configuration

Source: https://docs.yoctoproject.org/_sources/dev-manual/new-recipe.rst.txt

A general example of recipe variables including licensing, source URI, and installation logic.

```bitbake
LICENSE = "BSD-2-Clause | GPL-2.0-only"
LIC_FILES_CHKSUM = "file://lib/LICENSE;md5=ebc2ea4814a64de7708f1571904b32cc \
                    file://programs/COPYING;md5=b234ee4d69f5fce4486a80fdaf4a4263 \
                    file://LICENSE;md5=d57c0d21cb917fb4e0af2454aa48b956 \
                    "

PE = "1"

SRCREV = "d44371841a2f1728a3f36839fd4b7e872d0927d3"

SRC_URI = "git://github.com/lz4/lz4.git;branch=release;protocol=https \
           file://CVE-2021-3520.patch \
           "
UPSTREAM_CHECK_GITTAGREGEX = "v(?P<pver>.*)"

CVE_STATUS[CVE-2014-4715] = "fixed-version: Fixed in r118, which is larger than the current version"

EXTRA_OEMAKE = "PREFIX=${prefix} CC='${CC}' CFLAGS='${CFLAGS}' DESTDIR=${D} LIBDIR=${libdir} INCLUDEDIR=${includedir} BUILD_STATIC=no"

do_install() {
        oe_runmake install
}

BBCLASSEXTEND = "native nativesdk"
```

--------------------------------

### Running the SDK installer and environment setup

Source: https://docs.yoctoproject.org/sdk-manual/extensible.html

Execution of the installer script and the command to source the environment setup script for a new shell session.

```bash
$ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh
Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5
==========================================================================
Enter target directory for SDK (default: poky_sdk):
You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y
Extracting SDK..............done
Setting it up...
Extracting buildtools...
Preparing build system...
Parsing recipes: 100% |##################################################################| Time: 0:00:52
Initialising tasks: 100% |###############################################################| Time: 0:00:00
Checking sstate mirror object availability: 100% |#######################################| Time: 0:00:00
Loading cache: 100% |####################################################################| Time: 0:00:00
Initialising tasks: 100% |###############################################################| Time: 0:00:00
done
SDK has been successfully set up and is ready to be used.
Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
 $ . /home/scottrif/poky_sdk/environment-setup-core2-64-poky-linux
```

--------------------------------

### Setup Directory Name Expansion

Source: https://docs.yoctoproject.org/bitbake/2.16/bitbake-user-manual/bitbake-user-manual-environment-setup.html

Example of using variable expansion in setup-dir-name based on user-selected fragments.

```json
{
    ...
    "oe-fragments-one-of": {
        "machine": {
            "description": "Target machines",
            "options" : ["machine/gadget", "machine/gizmo"]
        }
    },
    "setup-dir-name": "somebuild-$machine"
    ...
}
```

--------------------------------

### JSON Configuration for Setup Directory Name

Source: https://docs.yoctoproject.org/bitbake/2.16/_sources/bitbake-user-manual/bitbake-user-manual-environment-setup.rst.txt

Example of a JSON configuration file demonstrating variable expansion for the setup directory name. This allows dynamic naming based on user choices during initialization.

```json
{
    "oe-fragments-one-of": {
        "machine": {
            "description": "Target machines",
            "options" : ["machine/gadget", "machine/gizmo"]
        }
    },
    "setup-dir-name": "somebuild-$machine"
}
```

--------------------------------

### BitBake Setup Configuration File Example

Source: https://docs.yoctoproject.org/bitbake/2.16/_sources/bitbake-user-manual/bitbake-user-manual-environment-setup.rst.txt

An example of a `settings.conf` file used by `bitbake-setup`. Settings are stored in INI format and can be overridden by command-line arguments.

```ini
[default]
top-dir-prefix = /path/to/workspace
top-dir-name = bitbake-builds
registry = /path/to/bitbake/default-registry
dl-dir = /path/to/bitbake-setup-downloads
use-full-setup-dir-name = yes

```

--------------------------------

### Source the Extensible SDK environment script

Source: https://docs.yoctoproject.org/sdk-manual/extensible.html

Initialize the SDK environment by navigating to the installation directory and sourcing the architecture-specific setup script.

```bash
$ cd /home/scottrif/poky_sdk
$ source environment-setup-core2-64-poky-linux
```

```bash
$ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux
```

--------------------------------

### Install openSUSE Leap Documentation Build Dependencies

Source: https://docs.yoctoproject.org/ref-manual/system-requirements.html

Packages and virtual environment setup for building project documentation manuals.

```bash
sudo zypper install git glibc-i18ndata make python3-pip rsvg-convert which
```

```bash
python3 -m venv --clear ./yocto-docs-venv
. ./yocto-docs-venv/bin/activate
python3 -m pip install sphinx sphinx_rtd_theme pyyaml sphinx-copybutton 'sphinxcontrib-svg2pdfconverter>=2.0.0'
```

--------------------------------

### Setup Documentation Virtual Environment

Source: https://docs.yoctoproject.org/ref-manual/system-requirements.html

Creates and activates a Python virtual environment and installs the necessary Sphinx dependencies for documentation builds.

```bash
python3 -m venv --clear ./yocto-docs-venv
. ./yocto-docs-venv/bin/activate
python3 -m pip install sphinx sphinx_rtd_theme pyyaml sphinx-copybutton 'sphinxcontrib-svg2pdfconverter>=2.0.0'
```

--------------------------------

### Configure psplash build options

Source: https://docs.yoctoproject.org/ref-manual/variables.html

Example of adding specific configuration flags to the psplash recipe.

```bitbake
EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen"
```

--------------------------------

### Define UBOOT_FIT_USER_SETTINGS

Source: https://docs.yoctoproject.org/ref-manual/variables.html

Example of the original ITS structure and how to append custom nodes using UBOOT_FIT_USER_SETTINGS with proper shell escaping.

```dts
images {
    uboot {
        description = "U-Boot image";
        data = /incbin/("u-boot-nodtb.bin");
        type = "standalone";
        os = "u-boot";
        arch = "";
        compression = "none";
        load = <0x80000000>;
        entry = <0x80000000>;
    };
};
```

```bitbake
UBOOT_FIT_FWA_ITS = '\
    fwa {\n\
        description = "FW A";\n\
        data = /incbin/("fwa.bin");\n\
        type = "firmware";\n\
        arch = "";\n\
        os = "";\n\
        load = <0xb2000000>;\n\
        entry = <0xb2000000>;\n\
        compression = "none";\n\
    };\n\
'

UBOOT_FIT_USER_SETTINGS = "${UBOOT_FIT_FWA_ITS}"
```

```dts
images {
    uboot {
        description = "U-Boot image";
        data = /incbin/("u-boot-nodtb.bin");
        type = "standalone";
        os = "u-boot";
        arch = "";
        compression = "none";
        load = <0x80000000>;
        entry = <0x80000000>;
    };
    fwa {
        description = "FW A";
        data = /incbin/("fwa.bin");
        type = "firmware";
        arch = "";
        os = "";
        load = <0xb2000000>;
        entry = <0xb2000000>;
        compression = "none";
    };
};
```

--------------------------------

### Configure psplash with custom images

Source: https://docs.yoctoproject.org/ref-manual/variables.html

Example structure and configuration for adding a custom splashscreen image to an ACME board.

```text
meta-acme/recipes-core/psplash
├── files
│   └── logo-acme.png
└── psplash_%.bbappend
```

```bitbake
SPLASH_IMAGES = "file://logo-acme.png;outsuffix=default"
FILESEXTRAPATHS:prepend := "${THISDIR}/files:"
```

--------------------------------

### Configure CMake for Systemd

Source: https://docs.yoctoproject.org/ref-manual/variables.html

Conditional installation of a systemd service file based on CMake flags.

```cmake
if(WITH_SYSTEMD)
   install(FILES ${PROJECT_SOURCE_DIR}/example.service DESTINATION /etc/systemd/systemd)
endif(WITH_SYSTEMD)
```

--------------------------------

### Example Error Message with LICENSE_FLAGS_DETAILS

Source: https://docs.yoctoproject.org/ref-manual/variables.html

The output format of an error message when a restricted license flag is missing from LICENSE_FLAGS_ACCEPTED.

```text
Has a restricted license 'FooBar-EULA' which is not listed in your LICENSE_FLAGS_ACCEPTED.
For further details, see https://example.com/eula.
```

--------------------------------

### Initialize a Setup with command-line arguments

Source: https://docs.yoctoproject.org/bitbake/2.16/bitbake-user-manual/bitbake-user-manual-environment-setup.html

Demonstrates passing configuration choices directly to the init command.

```bash
bitbake-setup init <generic config> poky distro/poky-tiny ...
```

--------------------------------

### Enter setup directory name

Source: https://docs.yoctoproject.org/_sources/brief-yoctoprojectqs/index.rst.txt

Interactive prompt for defining the setup directory name.

```text
Enter setup directory name: [poky-master-poky-distro_poky-machine_qemux86-64]
```

--------------------------------

### SDK Installer Filename Convention

Source: https://docs.yoctoproject.org/_sources/sdk-manual/appendix-obtain.rst.txt

This is an example of the naming convention for SDK installer files. The '-ext' string is absent in standard SDK installers.

```text
poky-glibc-*host_system*-core-image-*type*-*arch*-toolchain[-ext]-*release*.sh
```

--------------------------------

### QEMU Basic Run Examples

Source: https://docs.yoctoproject.org/_sources/dev-manual/qemu.rst.txt

Illustrates basic usage of the runqemu script for launching QEMU with different configurations, including specifying machine types, image paths, and filesystem types.

```shell
runqemu
```

```shell
runqemu qemuarm
```

```shell
runqemu tmp/deploy/images/qemuarm
```

```shell
runqemu tmp/deploy/images/qemux86/<qemuboot.conf>
```

```shell
runqemu qemux86-64 core-image-sato ext4
```

```shell
runqemu qemux86-64 wic-image-minimal wic
```

--------------------------------

### Install Buildtools

Source: https://docs.yoctoproject.org/bitbake/2.16/_sources/bitbake-user-manual/bitbake-user-manual-environment-setup.rst.txt

Use `bitbake-setup install-buildtools` to install a buildtools tarball into your setup. The `--force` option can be used to re-install.

```bash
bitbake-setup install-buildtools

```

```bash
bitbake-setup install-buildtools --force

```

```bash
bitbake-setup install-buildtools --setup-dir /path/to/setup

```

--------------------------------

### Basic runqemu Usage Examples

Source: https://docs.yoctoproject.org/_sources/dev-manual/qemu.rst.txt

Illustrates fundamental ways to invoke the runqemu script with different arguments for kernel images, root file systems, and serial console.

```bash
runqemu path/to/bzImage-qemux86.bin path/to/nfsrootdir/ serial
```

```bash
runqemu qemux86 iso/hddimg/wic.vmdk/wic.qcow2/wic.vdi/ramfs/cpio.gz...
```

```bash
runqemu qemux86 qemuparams="-m 256"
```

```bash
runqemu qemux86 bootparams="psplash=false"
```

```bash
runqemu path/to/<image>-<machine>.wic
```

```bash
runqemu path/to/<image>-<machine>.wic.vmdk
```

--------------------------------

### Example settings.conf file

Source: https://docs.yoctoproject.org/bitbake/2.16/bitbake-user-manual/bitbake-user-manual-environment-setup.html

A sample configuration file demonstrating various settings in INI format.

```ini
[default]
top-dir-prefix = /path/to/workspace
top-dir-name = bitbake-builds
registry = /path/to/bitbake/default-registry
dl-dir = /path/to/bitbake-setup-downloads
use-full-setup-dir-name = yes
```

--------------------------------

### Example of a bin_package recipe

Source: https://docs.yoctoproject.org/_sources/dev-manual/new-recipe.rst.txt

A basic recipe example using the bin_package class to install pre-compiled binary files without configuration or compilation steps.

```bitbake
SRC_URI = "https://www.kernel.org/pub/software/network/${BPN}/${BP}.tar.xz"
SRC_URI[sha256sum] = "57f8e7721cf5a880c13ae0c202edbb21092a060d45f9e9c59bcd2a8272bfa456"

inherit bin_package allarch

do_install() {
    install -d -m0755 ${D}${nonarch_libdir}/crda
    install -d -m0755 ${D}${sysconfdir}/wireless-regdb/pubkeys
    install -m 0644 regulatory.bin ${D}${nonarch_libdir}/crda/regulatory.bin
    install -m 0644 wens.key.pub.pem ${D}${sysconfdir}/wireless-regdb/pubkeys/wens.key.pub.pem
    install -m 0644 -D regulatory.db ${D}${nonarch_base_libdir}/firmware/regulatory.db
    install -m 0644 regulatory.db.p7s ${D}${nonarch_base_libdir}/firmware/regulatory.db.p7s
}
```

--------------------------------

### Restore Layer Setup

Source: https://docs.yoctoproject.org/_sources/dev-manual/layers.rst.txt

Execute the generated setup script to restore a previously saved layer configuration. This script requires Python 3 and Git to be installed.

```bash
alex@Zen2:/srv/work/alex/my-build$ meta-alex/setup-layers
Note: not checking out source meta-alex, use --force-bootstraplayer-checkout to override.

Setting up source meta-intel, revision 15.0-hardknott-3.3-310-g0a96edae, branch master
Running 'git init -q /srv/work/alex/my-build/meta-intel'
Running 'git remote remove origin > /dev/null 2>&1; git remote add origin git://git.yoctoproject.org/meta-intel' in /srv/work/alex/my-build/meta-intel
Running 'git fetch -q origin || true' in /srv/work/alex/my-build/meta-intel
Running 'git checkout -q 0a96edae609a3f48befac36af82cf1eed6786b4a' in /srv/work/alex/my-build/meta-intel

Setting up source poky, revision 4.1_M1-372-g55483d28f2, branch akanavin/setup-layers
Running 'git init -q /srv/work/alex/my-build/poky'
Running 'git remote remove origin > /dev/null 2>&1; git remote add origin git://git.yoctoproject.org/poky' in /srv/work/alex/my-build/poky
Running 'git fetch -q origin || true' in /srv/work/alex/my-build/poky
Running 'git remote remove poky-contrib > /dev/null 2>&1; git remote add poky-contrib ssh://git@push.yoctoproject.org/poky-contrib' in /srv/work/alex/my-build/poky
Running 'git fetch -q poky-contrib || true' in /srv/work/alex/my-build/poky
Running 'git checkout -q 11db0390b02acac1324e0f827beb0e2e3d0d1d63' in /srv/work/alex/my-build/poky
```

--------------------------------

### Build and Install Project

Source: https://docs.yoctoproject.org/_sources/sdk-manual/working-projects.rst.txt

Compiles the project using 'make' and installs it into a specified destination directory using 'make install'.

```console
$ make
$ make install DESTDIR=./tmp
```

--------------------------------

### Default SDK Installation Path Configuration

Source: https://docs.yoctoproject.org/_sources/sdk-manual/appendix-customizing.rst.txt

The default installation directory for the Extensible SDK is determined by the DISTRO and SDKEXTPATH variables. This example shows the default configuration.

```none
SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk"
```

--------------------------------

### Initialize a Setup from a remote configuration file

Source: https://docs.yoctoproject.org/bitbake/2.16/bitbake-user-manual/bitbake-user-manual-environment-setup.html

Uses a remote JSON configuration file to initialize the setup.

```bash
$ ./bitbake/bin/bitbake-setup init https://git.openembedded.org/bitbake/plain/default-registry/configurations/oe-nodistro-master.conf.json
```

--------------------------------

### Configure UBOOT_ENV for U-Boot

Source: https://docs.yoctoproject.org/_sources/ref-manual/variables.rst.txt

Examples for adding environment scripts or files to the U-Boot installation.

```bitbake
UBOOT_ENV = "boot"
UBOOT_ENV_SUFFIX = "scr"
SRC_URI += "file://${UBOOT_ENV_SRC}"
```

```bitbake
UBOOT_ENV = "uEnv"
UBOOT_ENV_SUFFIX = "txt"
SRC_URI += "file://${UBOOT_ENV_BINARY}"
```

--------------------------------

### Example SDK Information File

Source: https://docs.yoctoproject.org/_sources/dev-manual/build-quality.rst.txt

Displays the contents of sdk-info.txt, which provides metadata about the SDK build environment and size.

```none
DISTRO = poky
DISTRO_VERSION = 1.3+snapshot-20130327
SDK_NAME = poky-glibc-i686-arm
SDK_VERSION = 1.3+snapshot
SDKMACHINE =
SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs
BAD_RECOMMENDATIONS =
SDKSIZE = 352712
```

--------------------------------

### Example Run QEMU Command

Source: https://docs.yoctoproject.org/_sources/migration-guides/migration-2.2.rst.txt

This example demonstrates running QEMU with the qemux86-64 machine, specifying the root filesystem, kernel image, and the 'nographic' option.

```bash
$ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
```

--------------------------------

### Configure NO_RECOMMENDATIONS

Source: https://docs.yoctoproject.org/_sources/ref-manual/variables.rst.txt

Examples for disabling recommended package installation globally or for a specific recipe.

```bitbake
NO_RECOMMENDATIONS = "1"
```

```bitbake
NO_RECOMMENDATIONS:pn-target_image = "1"
```

--------------------------------

### Configure IMAGE_EXTRA_PARTITION_FILES with renaming

Source: https://docs.yoctoproject.org/_sources/ref-manual/variables.rst.txt

Example of installing files into extra partitions with optional renaming.

```bitbake
IMAGE_EXTRA_PARTITION_FILES = "foobar file.conf;config"
```

--------------------------------

### Extensible SDK Build Error Example

Source: https://docs.yoctoproject.org/_sources/sdk-manual/appendix-obtain.rst.txt

This is an example error message that occurs when building an Extensible SDK installer if the SDKMACHINE variable is not set correctly for the build machine's architecture.

```text
The extensible SDK can currently only be built for the same
machine as the machine being built on - SDK_ARCH
is set to i686 (likely via setting SDKMACHINE) which is
different from the architecture of the build machine (x86_64).
Unable to continue.
```

--------------------------------

### Initialize a Setup from a custom registry

Source: https://docs.yoctoproject.org/bitbake/2.16/bitbake-user-manual/bitbake-user-manual-environment-setup.html

Prompts the user to select a Generic Configuration from a specified Git registry.

```bash
$ ./bitbake/bin/bitbake-setup \
    --setting default registry 'git://example.com/bitbake-setup-configurations.git;protocol=https;branch=main;rev=main' \
    init
```
Tokens:
Raw