Skip to content

Latest commit

 

History

History
329 lines (235 loc) · 12.5 KB

README.md

File metadata and controls

329 lines (235 loc) · 12.5 KB

build-yocto

This subproject of easy-build provides a quick and easy way for creating embedded Linux distributions using the Yocto Project tools.

Building the Docker image

$ cd .../easy-build
$ docker build -t gmacario/build-yocto build-yocto/

Running the Docker image

Type the following command to instantiate a clean development environment for the Yocto Project:

$ docker run -ti gmacario/build-yocto

Optionally, you may use the --volume=[host-src:]container-dest option to share a directory between the host and the container, as in the following example

$ docker run -ti --volume=${PWD}/shared:/home/build/shared gmacario/build-yocto

Please refer to https://docs.docker.com/engine/reference/run/#volume-shared-filesystems for details

Congratulations! You can now execute the Yocto Project tools to create your own embedded Linux distribution.

Using Yocto

This section shows a few commands to make sure that the Yocto build environment is properly installed. Please refer to the Yocto Project documentation for details.

Clone the Yocto metadata

Clone the poky repository (in our example, Yocto Project 2.0 - a.k.a. "jethro")

$ mkdir -p ~/shared && sudo chown build.build ~/shared
$ cd ~/shared
$ git clone -b jethro git://git.yoctoproject.org/poky

Update the Yocto metadata

Fetch the latest updates of the poky repository

$ cd ~/shared/poky && git pull --all --prune

Create the build environment

$ cd ~/shared
$ source ~/shared/poky/oe-init-build-env ~/shared/build-test01

You may inspect and - if necessary - change the configuration files under conf/.

Build the minimal Yocto image

After sourcing oe-init-build-env you are ready to start the build

$ bitbake -k core-image-minimal

Result

build@afaf6ac0c0e4:~/shared/build-test01$ bitbake -k core-image-minimal
Parsing recipes: 100% |############################################################################################| Time: 00:00:25
Parsing of 899 .bb files complete (0 cached, 899 parsed). 1329 targets, 38 skipped, 0 masked, 0 errors.
NOTE: Resolving any missing task queue dependencies

Build Configuration:
BB_VERSION        = "1.28.0"
BUILD_SYS         = "x86_64-linux"
NATIVELSBSTRING   = "Ubuntu-14.04"
TARGET_SYS        = "i586-poky-linux"
MACHINE           = "qemux86"
DISTRO            = "poky"
DISTRO_VERSION    = "2.0.1"
TUNE_FEATURES     = "m32 i586"
TARGET_FPU        = ""
meta
meta-yocto
meta-yocto-bsp    = "jethro:7fe17a2942ff03e2ec47d566fd5393f52b2eb736"

NOTE: Preparing RunQueue
NOTE: Executing SetScene Tasks
NOTE: Executing RunQueue Tasks
WARNING: Failed to fetch URL ftp://invisible-island.net/ncurses/current/ncurses-5.9-20150329.tgz, attempting MIRRORS if available
WARNING: Failed to fetch URL http://www.openssl.org/source/openssl-1.0.2d.tar.gz, attempting MIRRORS if available
WARNING: QA Issue: python-pygobject: /python-pygobject/usr/lib/python2.7/site-packages/pygtk.pth is owned by uid 30000, which is the same as the user running bitbake. This may be due to host contamination [host-user-contaminated]
NOTE: Tasks Summary: Attempted 2005 tasks of which 9 didn't need to be rerun and all succeeded.

Summary: There were 3 WARNING messages shown.
build@afaf6ac0c0e4:~/shared/build-test01$

The build results will be stored under tmp/deploy/images/${MACHINE}:

build@afaf6ac0c0e4:~/shared/build-test01$ ls -la tmp/deploy/images/qemux86/
total 97344
drwxr-xr-x 2 build build     4096 Feb 22 15:04 .
drwxr-xr-x 3 build build     4096 Feb 22 14:46 ..
-rw-r--r-- 2 build build      294 Feb 22 15:04 README_-_DO_NOT_DELETE_FILES_IN_THIS_DIRECTORY.txt
lrwxrwxrwx 1 build build       72 Feb 22 14:46 bzImage -> bzImage--4.1.17+git0+46bb64d605_2e0ac7b6c4-r0-qemux86-20160222140016.bin
-rw-r--r-- 2 build build  6978640 Feb 22 14:45 bzImage--4.1.17+git0+46bb64d605_2e0ac7b6c4-r0-qemux86-20160222140016.bin
lrwxrwxrwx 1 build build       72 Feb 22 14:46 bzImage-qemux86.bin -> bzImage--4.1.17+git0+46bb64d605_2e0ac7b6c4-r0-qemux86-20160222140016.bin
-rw-r--r-- 1 build build  9138176 Feb 22 15:04 core-image-minimal-qemux86-20160222140016.rootfs.ext4
-rw-r--r-- 1 build build      721 Feb 22 15:04 core-image-minimal-qemux86-20160222140016.rootfs.manifest
-rw-r--r-- 1 build build  2399203 Feb 22 15:04 core-image-minimal-qemux86-20160222140016.rootfs.tar.bz2
lrwxrwxrwx 1 build build       53 Feb 22 15:04 core-image-minimal-qemux86.ext4 -> core-image-minimal-qemux86-20160222140016.rootfs.ext4
lrwxrwxrwx 1 build build       57 Feb 22 15:04 core-image-minimal-qemux86.manifest -> core-image-minimal-qemux86-20160222140016.rootfs.manifest
lrwxrwxrwx 1 build build       56 Feb 22 15:04 core-image-minimal-qemux86.tar.bz2 -> core-image-minimal-qemux86-20160222140016.rootfs.tar.bz2
-rw-r--r-- 2 build build 83265178 Feb 22 14:46 modules--4.1.17+git0+46bb64d605_2e0ac7b6c4-r0-qemux86-20160222140016.tgz
lrwxrwxrwx 1 build build       72 Feb 22 14:46 modules-qemux86.tgz -> modules--4.1.17+git0+46bb64d605_2e0ac7b6c4-r0-qemux86-20160222140016.tgz
build@afaf6ac0c0e4:~/shared/build-test01$

Using the "wic" tool

Starting from release 1.5 of the Yocto project, the wic tool can be used to build system images.

Show program version

$ wic --version

Yocto 2.0 (jethro) features wic version 0.2.0:

build@afaf6ac0c0e4:~/shared/build-test01$ wic --version
wic version 0.2.0
build@afaf6ac0c0e4:~/shared/build-test01$

Show program help

$ wic --help

Result:

build@afaf6ac0c0e4:~/shared/build-test01$ wic --help
Usage:

 Create a customized OpenEmbedded image

 usage: wic [--version] | [--help] | [COMMAND [ARGS]]

 Current 'wic' commands are:
    help              Show help for command or one of the topics (see below)
    create            Create a new OpenEmbedded image
    list              List available canned images and source plugins

 Help topics:
    overview          wic overview - General overview of wic
    plugins           wic plugins - Overview and API
    kickstart         wic kickstart - wic kickstart reference


Options:
  --version   show program's version number and exit
  -h, --help  show this help message and exit
build@afaf6ac0c0e4:~/shared/build-test01$

List available OpenEmbedded image properties

$ wic list images

Result:

build@afaf6ac0c0e4:~/shared/build-test01$ wic list images
  mkhybridiso                                   Create a hybrid ISO image
  directdisk-multi-rootfs                       Create multi rootfs image using rootfs plugin
  qemux86-directdisk                            Create a qemu machine 'pcbios' direct disk image
  directdisk-gpt                                Create a 'pcbios' direct disk image
  mkgummidisk                                   Create an EFI disk image
  directdisk                                    Create a 'pcbios' direct disk image
  sdimage-bootpart                              Create SD card image with a boot partition
  mkefidisk                                     Create an EFI disk image
build@afaf6ac0c0e4:~/shared/build-test01$

Getting help on "wic create"

$ wic help create

Result:

NAME
    wic create - Create a new OpenEmbedded image

SYNOPSIS
    wic create <wks file or image name> [-o <DIRNAME> | --outdir <DIRNAME>]
        [-e | --image-name] [-s, --skip-build-check] [-D, --debug]
        [-r, --rootfs-dir] [-b, --bootimg-dir]
        [-k, --kernel-dir] [-n, --native-sysroot] [-f, --build-rootfs]
        [-c, --compress-with]

DESCRIPTION
    This command creates an OpenEmbedded image based on the 'OE
    kickstart commands' found in the <wks file>.

    In order to do this, wic needs to know the locations of the
    various build artifacts required to build the image.

    Users can explicitly specify the build artifact locations using
    the -r, -b, -k, and -n options.  See below for details on where
    the corresponding artifacts are typically found in a normal
    OpenEmbedded build.

    Alternatively, users can use the -e option to have 'wic' determine
    those locations for a given image.  If the -e option is used, the
    user needs to have set the appropriate MACHINE variable in
    local.conf, and have sourced the build environment.

    The -e option is used to specify the name of the image to use the
    artifacts from e.g. core-image-sato.

    The -r option is used to specify the path to the /rootfs dir to
    use as the .wks rootfs source.

    The -b option is used to specify the path to the dir containing
    the boot artifacts (e.g. /EFI or /syslinux dirs) to use as the
    .wks bootimg source.

    The -k option is used to specify the path to the dir containing
    the kernel to use in the .wks bootimg.

    The -n option is used to specify the path to the native sysroot
    containing the tools to use to build the image.

    The -f option is used to build rootfs by running "bitbake <image>"

    The -s option is used to skip the build check.  The build check is
    a simple sanity check used to determine whether the user has
    sourced the build environment so that the -e option can operate
    correctly.  If the user has specified the build artifact locations
    explicitly, 'wic' assumes the user knows what he or she is doing
    and skips the build check.

    The -D option is used to display debug information detailing
    exactly what happens behind the scenes when a create request is
    fulfilled (or not, as the case may be).  It enumerates and
    displays the command sequence used, and should be included in any
    bug report describing unexpected results.

    When 'wic -e' is used, the locations for the build artifacts
    values are determined by 'wic -e' from the output of the 'bitbake
    -e' command given an image name e.g. 'core-image-minimal' and a
    given machine set in local.conf.  In that case, the image is
    created as if the following 'bitbake -e' variables were used:

    -r:        IMAGE_ROOTFS
    -k:        STAGING_KERNEL_DIR
    -n:        STAGING_DIR_NATIVE
    -b:        empty (plugin-specific handlers must determine this)

    If 'wic -e' is not used, the user needs to select the appropriate
    value for -b (as well as -r, -k, and -n).

    If 'wic -e' is not used, the user needs to select the appropriate
    value for -b (as well as -r, -k, and -n).

    The -o option can be used to place the image in a directory with a
    different name and location.

    The -c option is used to specify compressor utility to compress
    an image. gzip, bzip2 and xz compressors are supported.

Create image

$ bitbake dosfstools-native mtools-native parted-native syslinux
$ wic create directdisk -e core-image-minimal

Result:

build@afaf6ac0c0e4:~/shared/build-test01$ wic create directdisk -e core-image-minimal
Checking basic build environment...
Done.

Creating image(s)...

Info: The new image(s) can be found here:
  /var/tmp/wic/build/directdisk-201602221523-sda.direct

The following build artifacts were used to create the image(s):
  ROOTFS_DIR:                   /home/build/shared/build-test01/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/rootfs
  BOOTIMG_DIR:                  /home/build/shared/build-test01/tmp/sysroots/qemux86/usr/share
  KERNEL_DIR:                   /home/build/shared/build-test01/tmp/deploy/images/qemux86
  NATIVE_SYSROOT:               /home/build/shared/build-test01/tmp/sysroots/x86_64-linux


The image(s) were created using OE kickstart file:
  /home/build/shared/poky/scripts/lib/wic/canned-wks/directdisk.wks
build@afaf6ac0c0e4:~/shared/build-test01$

Known issues and workarounds

bitbake complains if run as root

root@eb4b9143265d:/work/build-test01# bitbake -k core-image-sato
ERROR:  OE-core's config sanity checker detected a potential misconfiguration.
    Either fix the cause of this error or at your own risk disable the checker (see sanity.conf).
    Following is the list of potential problems / advisories:

    Do not use Bitbake as root.
ERROR: Execution of event handler 'check_sanity_eventhandler' failed
ERROR: Command execution failed: Exited with 1

Summary: There were 3 ERROR messages shown, returning a non-zero exit code.
root@eb4b9143265d:/work/build-test01#

Workaround:

$ touch conf/sanity.conf