BitBake

https://docs.yoctoproject.org/bitbake/
Admin
BitBake is a task execution engine and metadata parser that uses recipes, configuration files, and...
Tokens:75,632
Snippets:1,237
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize setup with configuration file

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Command to initialize a setup using a standalone JSON configuration file.

```bash
$ bitbake-setup init /path/to/config.conf.json
```

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

### Initialize Setup from Custom Registry

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Configure a custom registry URL and initialize the setup interactively.

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

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

### Initialize Setup from Remote Template

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Initialize a setup using a configuration template file hosted at a remote HTTP URI.

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

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

### BitBake Configuration Template Example

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

A JSON structure defining layers, environment passthrough, and available machine/distribution fragments for a BitBake setup.

```json
{
   "bitbake-setup": {
      "configurations": [
      {
          "bb-layers": ["openembedded-core/meta","meta-yocto/meta-yocto-bsp","meta-yocto/meta-poky"],
          "bb-env-passthrough-additions": ["DL_DIR","SSTATE_DIR"],
          "oe-fragments-one-of": {
              "machine": {
                  "description": "Target machines",
                  "options" : [
                      { "name": "machine/qemux86-64", "description": "Machine configuration for running an x86-64 system on QEMU" },
                      { "name": "machine/qemuarm64", "description": "Machine configuration for running an ARMv8 system on QEMU" },
                      { "name": "machine/qemuriscv64", "description": "Machine configuration for running an RISC-V system on QEMU" },
                      { "name": "machine/genericarm64", "description": "Machine configuration for Arm64 SystemReady IR/ES platforms" },
                      { "name": "machine/genericx86-64", "description": "Machine configuration for generic x86_64 (64-bit) PCs and servers" }
                  ]
              },
              "distro": {
                  "description": "Target Distributions",
                  "options" : [
                      { "name": "distro/poky", "description": "Distro configuration for Poky (Yocto Project Reference Distro)" },
                      { "name": "distro/poky-altcfg", "description": "Distro configuration for Poky (systemd init manager)" },
                      { "name": "distro/poky-tiny", "description": "Distro configuration for Poky (optimized for size)" }
                  ]
              }
          },
          "configurations": [
          {
              "name": "poky",
              "description": "Poky - The Yocto Project testing distribution"
          },
          {
              "name": "poky-with-sstate",
              "description": "Poky - The Yocto Project testing distribution with internet sstate acceleration. Use with caution as it requires a completely robust local network with sufficient bandwidth.",
              "oe-fragments": ["core/yocto/sstate-mirror-cdn"]
          }
          ]
      }
      ]
   }
}
```

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

### Initialize bitbake-setup

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Run the setup utility to select configuration templates and prepare the build environment.

```bash
$ ./bitbake/bin/bitbake-setup init
```

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

### Configure ClearCase Fetcher

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Example configuration for using the ClearCase fetcher in a recipe.

```bitbake
SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module"
SRCREV = "EXAMPLE_CLEARCASE_TAG"
PV = "${@d.getVar("SRCREV", False).replace("/", "+")}"
```

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

### Example settings.conf file

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

A sample configuration file demonstrating common 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
common-sstate = yes
```

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

### Common Git Fetcher URL Examples

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Examples of SRC_URI configurations for various Git repository sources using different protocols and parameters.

```bitbake
SRC_URI = "git://github.com/fronteed/icheck.git;protocol=https;branch=${PV};tag=${PV}"
SRC_URI = "git://github.com/asciidoc/asciidoc-py;protocol=https;branch=main"
SRC_URI = "git://git@gitlab.freedesktop.org/mesa/mesa.git;branch=main;protocol=ssh;..."
```

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

### Configure HTTP/FTP Fetcher

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Examples of using web and FTP protocols with the wget fetcher.

```bitbake
SRC_URI = "http://oe.handhelds.org/not_there.aac"
SRC_URI = "ftp://oe.handhelds.org/not_there_as_well.aac"
SRC_URI = "ftp://you@oe.handhelds.org/home/you/secret.plan"
```

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

### Initialize Setup with Command-Line Arguments

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Pass configuration choices directly to the init command to bypass interactive prompts.

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

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

### bitbake-setup update

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Updates a Setup to sync with the latest changes from the Configuration Template it was constructed from.

```APIDOC
## bitbake-setup update

### Description
Updates a Setup to sync with the latest changes from the Configuration Template. Local commits are rebased onto the new upstream revision.

### Parameters
#### Options
- **--update-bb-conf** (string) - Optional - Whether to update BitBake Build configuration (prompt, yes, no).
- **--rebase-conflicts-strategy** (string) - Optional - Strategy for handling conflicts (abort, backup).
- **--setup-dir** (string) - Optional - Path to the Setup to update.
```

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

### Examples of BB_DISKMON_DIRS Configuration

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

Common usage patterns for setting disk monitoring thresholds and actions.

```text
BB_DISKMON_DIRS = "HALT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K"
BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G"
BB_DISKMON_DIRS = "HALT,${TMPDIR},,100K"
```

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

### Example of BB_DISKMON_WARNINTERVAL Usage

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

Configuring warning intervals in conjunction with the WARN action in BB_DISKMON_DIRS.

```text
BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K"
BB_DISKMON_WARNINTERVAL = "50M,5K"
```

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

### Example directory structure

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Visual representation of the file and directory layout generated by the initialization process.

```text
./bitbake-builds/
├── site.conf
└── poky-master-poky-distro_poky-machine_qemux86-64/
 	├── build/
 	├── config/
 	└── layers/
```

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

### BitBake Setup Directory Hierarchy

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Visual representation of the file and directory structure managed by bitbake-setup.

```text
Top Directory
├── site.conf
├── Setup 1
│   ├── build/
│   ├── config/
│   └── layers/
├── Setup 2
│   ├── build/
│   ├── config/
│   └── layers/
...
```

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

### Configure Local File Fetcher

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Examples of using the file:// protocol with relative and absolute paths.

```bitbake
SRC_URI = "file://relativefile.patch"
SRC_URI = "file:///Users/ich/very_important_software"
```

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

### Example RRECOMMENDS Usage

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

Sets a recommendation on version 1.2 or greater of the package foo.

```bitbake
RRECOMMENDS:${PN} = "foo (>= 1.2)"
```

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

### bitbake-setup status

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Shows the status of a Setup, including differences between the local copy and the upstream template.

```APIDOC
## bitbake-setup status

### Description
Shows the status of a Setup. Any differences between the local copy of the Configuration Template and the upstream one are printed on the console.

### Parameters
#### Options
- **--setup-dir** (string) - Optional - Path to the Setup to check status for.
```

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

### Subversion (SVN) Fetcher SRC_URI Examples

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Examples of configuring the SRC_URI variable for Subversion repositories using different protocols and parameters.

```bitbake
SRC_URI = "svn://myrepos/proj1;module=vip;protocol=http;rev=667"
SRC_URI = "svn://myrepos/proj1;module=opie;protocol=svn+ssh"
SRC_URI = "svn://myrepos/proj1;module=trunk;protocol=http;path_spec=${MY_DIR}/proj1"
```

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

### CVS Fetcher SRC_URI Examples

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Examples of configuring the SRC_URI variable for CVS repositories using various parameters.

```bitbake
SRC_URI = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext"
SRC_URI = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat"
```

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

### Search order for include files

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example search paths for a required file given a specific BBPATH configuration.

```text
/layers/meta-custom2/recipes-example/example/myfile.inc
/layers/meta-custom1/myfile.inc
/layers/meta-custom2/myfile.inc
```

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

### Version-Specific Recipe Name

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example of a recipe filename without a wildcard.

```text
mesa.bb
```

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

### Define sources in configuration template

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example showing how to define git repositories and local paths within the sources dictionary.

```json
{
   "sources": {
       "bitbake": {
           "git-remote": {
               "uri": "https://git.openembedded.org/bitbake",
               "branch": "master",
               "rev": "master"
           },
           "path": "bitbake"
       },
       "openembedded-core": {
           "local": {
               "path": "~/path/to/local/openembedded-core"
           }
       },
       "meta-private": {
           "git-remote": {
               "remotes": {
                   "origin": {
                       "uri": "ssh://git@git.example.com/meta-private"
                   }
               },
               "branch": "master",
               "rev": "master"
           },
           "path": "meta-private"
       }
   }
}
```

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

### Configure dynamic setup directory naming

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Use variable expansion in setup-dir-name to create directory names based on user-selected fragment options.

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

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

### Advanced Non-Interactive Setup Initialization

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Perform a non-interactive initialization with custom directory paths, source overrides, and local source symlinking.

```bash
$ ./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 \
    -L openembedded-core ~/development/openembedded-core-gadget \
    ./gadget_master.conf.json \
    gadget distro/gadget machine/gadget
```

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

### Example of versioned dependency

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

Sets a dependency on version 1.2 or greater of the package 'foo'.

```bitbake
RDEPENDS:${PN} = "foo (>= 1.2)"
```

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

### BBMASK Path Matching Examples

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

List of paths matched by the BBMASK configuration provided in the documentation.

```text
/bitbake-builds/poky-master/layers/meta-ti/meta-ti-bsp/recipes-graphics/libgal.bb
/bitbake-builds/poky-master/layers/meta-ti/meta-ti-bsp/recipes-graphics/libgal_%.bbappend
/bitbake-builds/poky-master/layers/meta-ti/meta-ti-bsp/recipes-graphics/libgal-foo/foo.bb
/bitbake-builds/poky-master/layers/meta-ti/meta-ti-bsp/recipes-graphics/libgal-foo/foo/bz.bbappend
/bitbake-builds/poky-master/layers/meta-ti/meta-ti-bsp/recipes-graphics/libgal/bar.bb
```

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

### Configure Azure Fetcher URL

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Example URL format for fetching artifacts from an Azure storage account.

```bitbake
SRC_URI = "az://<azure-storage-account>.blob.core.windows.net/<foo_container>/<bar_file>"
```

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

### ClearCase Load Rule Example

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

The resulting load rule generated by combining vob and module options.

```text
load /example_vob/example_module
```

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

### BitBake Append File Naming

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

Examples of using the % wildcard in .bbappend filenames to match recipe versions.

```text
busybox_1.21.%.bbappend
```

```text
busybox_1.21.1.bb
busybox_1.21.2.bb
busybox_1.21.3.bb
```

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

### Basic URL Fetching Configuration

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-fetching.rst.txt

Examples of setting SRC_URI for standard web-based fetching, including handling of download filenames.

```bitbake
SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47"
```

```bitbake
SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47;downloadfilename=myfile.bz2"
```

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

### BBMASK Directory Matching

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Examples demonstrating the difference between matching a directory with a trailing slash versus matching file prefixes.

```text
BBMASK += "${BBFILE_PATTERN_meta-ti-bsp}/recipes-graphics/libgal/"
```

```text
BBMASK += "${BBFILE_PATTERN_meta-ti-bsp}/recipes-graphics/libgal"
```

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

### Configure Repo Fetcher URLs

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Examples of SRC_URI definitions for the Google Repo fetcher using different protocols.

```bitbake
SRC_URI = "repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml"
SRC_URI = "repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml"
```

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

### Example recipe matches for wildcard append file

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-intro.html

These recipe filenames are matched by the busybox_1.21.%.bbappend pattern.

```text
busybox_1.21.1.bb
busybox_1.21.2.bb
busybox_1.21.3.bb
```

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

### Define PN and PV Variables

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-execution.rst.txt

Example of using recipe filenames to dynamically set package name (PN) and version (PV) variables.

```bitbake
PN = "${@bb.parse.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}"
PV = "${@bb.parse.vars_from_file(d.getVar('FILE', False),d)[1] or '1.0'}"
```

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

### Set PREFERRED_VERSION with wildcards

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

Examples of setting preferred recipe versions, including the use of the % wildcard for partial version matching.

```bitbake
PREFERRED_VERSION_python = "2.7.3"
PREFERRED_VERSION_linux-yocto = "4.12%"
```

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

### Handle Ambiguous URL Parameters

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Examples demonstrating how to resolve parsing issues caused by semi-colons in URLs by using ampersands and specifying download filenames.

```bitbake
SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git;a=snapshot;h=a5dd47"
```

```bitbake
SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47"
```

```bitbake
SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47;downloadfilename=myfile.bz2"
```

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

### Set BitBake Setup Configuration

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Updates a specific setting within a configuration section using the bitbake-setup tool.

```bash
bitbake-setup setting set default top-dir-name bitbake-builds
```

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

### Define Warning Level Logging Configuration

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-execution.rst.txt

Example JSON configuration to log all WARNING and higher priority messages to a file.

```json
{
    "version": 1,
    "formatters": {
        "warnlogFormatter": {
            "()": "bb.msg.BBLogFormatter",
            "format": "%(levelname)s: %(message)s"
        }
    },

    "handlers": {
        "warnlog": {
            "class": "logging.FileHandler",
            "formatter": "warnlogFormatter",
            "level": "WARNING",
            "filename": "warn.log"
        }
    },

    "loggers": {
        "BitBake": {
            "handlers": ["warnlog"]
        }
    },

    "@disable_existing_loggers": false
}
```

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

### Define Source Revision and Checksum Variables

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Examples of setting specific source revisions and checksums for recipe source URIs.

```bitbake
SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15"
SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f"
SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de"
```

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

### Get referenced variables in an expression

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Examples of expressions passed to bb.utils.get_referenced_vars to extract variable names.

```text
${VAR_A} string ${VAR_B}
```

```text
${@d.getVar('VAR')}
```

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

### Configure SRC_URI with Multiple Sources

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

Example of defining multiple source repositories and files with specific names for checksum association.

```bitbake
SRC_URI = "git://example.com/foo.git;branch=main;name=first \
           git://example.com/bar.git;branch=main;name=second \
           http://example.com/file.tar.gz;name=third"

SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15"
SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f"
SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de"
```

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

### BitBake Parsing Error Example

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-execution.rst.txt

Demonstrates a shell function that causes a parsing error due to a closing curly brace at the start of a line.

```bash
fakeroot create_shar() {
   cat << "EOF" > ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
usage()
{
   echo "test"
   ######  The following "}" at the start of the line causes a parsing error ######
}
EOF
}
```

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

### bitbake-setup list

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Lists the available Configuration Templates in the current registry.

```APIDOC
## bitbake-setup list

### Description
Lists the available Configuration Templates in the current registry.

### Parameters
#### Options
- **--with-expired** (flag) - Optional - List expired configuration templates.
- **--write-json** (flag) - Optional - Write the configurations into a JSON file.
```

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

### Create Configuration Directory and File

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-hello.rst.txt

Commands to create the conf directory and the required bitbake.conf file.

```bash
$ mkdir conf
```

```bash
PN  = "${@bb.parse.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}"

TMPDIR  = "${TOPDIR}/tmp"
CACHE   = "${TMPDIR}/cache"
STAMP   = "${TMPDIR}/${PN}/stamps"
T       = "${TMPDIR}/${PN}/work"
B       = "${TMPDIR}/${PN}"
```

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

### Include a file in a bbappend

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example of requiring a file within a bbappend file.

```bitbake
require myappend.inc
```

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

### Source the build environment

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Prepare the current shell session for BitBake operations.

```bash
$ source ./poky-master-poky-distro_poky-machine_qemux86-64/build/init-build-env
```

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

### Verify BitBake version

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-hello.rst.txt

Checks the installed version of the BitBake build tool.

```bash
$ ./bin/bitbake --version
BitBake Build Tool Core version 2.3.1
```

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

### Include a file from a subdirectory

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example of requiring a file located in a subdirectory relative to the recipe.

```bitbake
require recipes-other/other/otherfile.inc
```

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

### Version-Specific Append Filename

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example of an append filename that matches the specific recipe name.

```text
mesa.bbappend
```

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

### Run BitBake Initial Check

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-hello.rst.txt

Executing bitbake without configuration results in an error regarding missing BBPATH.

```bash
$ bitbake
ERROR: The BBPATH variable is not set and bitbake did not find a conf/bblayers.conf file in the expected location.
Maybe you accidentally invoked bitbake from the wrong directory?
```

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

### Execute Multiple Configuration Builds

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

Command syntax to initiate builds for specific multiconfig targets.

```bash
$ bitbake [mc:multiconfigname:]target [[[mc:multiconfigname:]target] ... ]
```

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

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

### Configure Multiple Source Control Repositories

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Demonstrates how to define multiple source repositories in SRC_URI and map them to specific revisions using SRCREV_FORMAT.

```bitbake
SRC_URI = " \
    git://git.some.example.com/source-tree.git;name=machine \
    git://git.some.example.com/metadata.git;name=meta \
    "
SRCREV_machine = "3f9db490a81eeb0077be3c5a5aa1388a2372232f"
SRCREV_meta = "1ac1d0ff730fe1dd1371823d562db8126750a98c"
SRCREV_FORMAT ?= "meta_machine"
```

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

### Create layer directory structure

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-hello.rst.txt

Commands to initialize a new layer and its configuration directory.

```bash
$ cd $HOME
$ mkdir mylayer
$ cd mylayer
$ mkdir conf
```

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

### Identify Unsupported Shell Arithmetic Expansion

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example of shell syntax that is not supported by the BitBake parser.

```shell
VAR=$(( i + 1 ))

```

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

### Configure BB_DISKMON_DIRS

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Sets up disk space and inode monitoring parameters for the build environment.

```text
BB_DISKMON_DIRS = "<action>,<dir>,<threshold> [...]"
```

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

### Inherit Directive Usage

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Examples of using the inherit directive to include functionality from .bbclass files.

```BitBake
inherit autotools
```

```BitBake
inherit buildhistory rm_work
```

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

### Create Project Directory

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-hello.rst.txt

Commands to create and enter a dedicated directory for BitBake project files.

```bash
$ mkdir ~/hello
$ cd ~/hello
```

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

### Define PREFERRED_PROVIDERS mapping

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

Example of using the bulk PREFERRED_PROVIDERS format to define multiple preferences at once.

```bitbake
PREFERRED_PROVIDERS = "xxx:yyy aaa:bbb ..."
```

```bitbake
PREFERRED_PROVIDER_xxx = "yyy"
PREFERRED_PROVIDER_aaa = "bbb"
```

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

### Configure Azure Fetcher

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-fetching.rst.txt

Setting up authentication and source URI for Azure Storage.

```bitbake
AZ_SAS = "se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>"
```

```bitbake
SRC_URI = "az://<azure-storage-account>.blob.core.windows.net/<foo_container>/<bar_file>"
```

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

### Define and manipulate variable flags

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-metadata.rst.txt

Examples of setting and appending to variable flags, including documentation tags.

```bitbake
FOO[a] = "abc"
FOO[b] = "123"
FOO[a] += "456"
CACHE[doc] = "The directory holding the cache of the metadata."
```

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

### Example of invalid BBFILES_DYNAMIC syntax

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

Shows an error message resulting from incorrectly formatted entries in the configuration.

```text
ERROR: BBFILES_DYNAMIC entries must be of the form {!}<collection name>:<filename pattern>, not:
/work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend
/work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend
```

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

### Download source files with BitBake Fetcher

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Initializes the fetcher instance using SRC_URI and executes the download process.

```python
src_uri = (d.getVar('SRC_URI') or "").split()
fetcher = bb.fetch2.Fetch(src_uri, d)
fetcher.download()
```

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

### Define a version-matching append file

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-intro.html

Use the % wildcard to match specific recipe versions.

```text
busybox_1.21.%.bbappend
```

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

### Compare URL fetcher protocols

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Demonstrates correct protocol usage for Git repositories, noting that the fetcher must match the URL scheme.

```text
https://git.yoctoproject.org/git/poky;protocol=git
git://git.yoctoproject.org/git/poky;protocol=http
```

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

### Define mirror configurations

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-fetching.html

Configures PREMIRRORS and MIRRORS to redirect source downloads to local or alternative servers.

```text
PREMIRRORS ?= "\
   bzr://.*/.*  http://somemirror.org/sources/ \
   cvs://.*/.*  http://somemirror.org/sources/ \
   git://.*/.*  http://somemirror.org/sources/ \
   hg://.*/.*   http://somemirror.org/sources/ \
   osc://.*/.*  http://somemirror.org/sources/ \
   p4://.*/.*   http://somemirror.org/sources/ \
  svn://.*/.*   http://somemirror.org/sources/"

MIRRORS =+ "\
   ftp://.*/.*   http://somemirror.org/sources/ \
   http://.*/.*  http://somemirror.org/sources/ \
   https://.*/.* http://somemirror.org/sources/"
```

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

### BitBake error output

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-hello.rst.txt

Example of a traceback error when BitBake fails to locate required class files.

```text
ERROR: Unable to parse /home/scott-lenovo/bitbake/lib/bb/parse/parse_py/BBHandler.py
Traceback (most recent call last):
File "/home/scott-lenovo/bitbake/lib/bb/parse/parse_py/BBHandler.py", line 67, in inherit(files=['base'], fn='configuration INHERITs', lineno=0, d=<bb.data_smart.DataSmart object at 0x7fab6815edf0>):
      if not os.path.exists(file):
>            raise ParseError("Could not inherit file %s" % (file), fn, lineno)

bb.parse.ParseError: ParseError in configuration INHERITs: Could not inherit file classes/base.bbclass
```

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

### Create classes directory

Source: https://docs.yoctoproject.org/bitbake/2.10/_sources/bitbake-user-manual/bitbake-user-manual-hello.rst.txt

Commands to create the classes directory within the project structure.

```bash
$ cd $HOME/hello
$ mkdir classes
```

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

### Define OpenEmbedded nodistro configuration

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Use this template to configure a basic OpenEmbedded 'nodistro' setup for master branches.

```json
{
    "description": "OpenEmbedded - 'nodistro' basic configuration",
    "sources": {
        "bitbake": {
            "git-remote": {
                "uri": "https://git.openembedded.org/bitbake",
                "branch": "master",
                "rev": "master"
            }
        },
        "openembedded-core": {
            "git-remote": {
                "uri": "https://git.openembedded.org/openembedded-core",
                "branch": "master",
                "rev": "master"
            }
        },
        "yocto-docs": {
            "git-remote": {
                "uri": "https://git.yoctoproject.org/yocto-docs",
                "branch": "master",
                "rev": "master"
            }
        }
    },
    "bitbake-setup": {
        "configurations": [
        {
            "name": "nodistro",
            "description": "OpenEmbedded 'nodistro'",
            "setup-dir-name": "oe-nodistro-master",
            "bb-layers": ["openembedded-core/meta"],
            "oe-fragments-one-of": {
                "machine": {
                    "description": "Target machines",
                    "options" : [
                        { "name": "machine/qemux86-64", "description": "x86-64 system on QEMU" },
                        { "name": "machine/qemuarm64", "description": "ARMv8 system on QEMU" },
                        { "name": "machine/qemuriscv64", "description": "RISC-V system on QEMU" }
                    ]
                }
            }
        }
        ]
    },
    "version": "1.0"
}
```

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

### Configure top-dir-prefix

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Sets the base path for the Top Directory.

```ini
[default]
top-dir-prefix = /path/to/workspace
```

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

### BBMASK Partial Path Matching

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example showing how omitting the caret (^) anchor allows matching any portion of a path.

```text
BBMASK = "recipes-graphics/libgal/"
```

```text
/bitbake-builds/poky-master/layers/meta-ti/meta-ti-bsp/recipes-graphics/libgal/
/bitbake-builds/poky-master/layers/my-layer/foo-recipes-graphics/libgal/
```

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

### Original Configuration Source Revision

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

An example of a source configuration specifying a branch without a fixed commit hash.

```json
"bitbake": {
    "git-remote": {
        "remotes": {
            "origin": {
                "uri": "https://git.openembedded.org/bitbake"
            }
        },
        "branch": "master",
        "rev": "master"
}
```

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

### Create project configuration directory

Source: https://docs.yoctoproject.org/bitbake/2.10/bitbake-user-manual/bitbake-user-manual-hello.html

Use this command to create the conf directory within your project root.

```bash
$ mkdir conf
```

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

### General Wildcard Append Filename

Source: https://docs.yoctoproject.org/bitbake/singleindex.html

Example of an append filename using the '%' wildcard to match multiple recipe variants.

```text
linux-yocto%.bbappend
```
Tokens:
Raw