oniro-quick-build.rst

|main_project_name| - Quick Build

This section will guide you to building your first |main_project_name| image targeting a supported reference hardware. It will also provide the steps for flashing and booting such an image.

The steps below will focus on a Qemu-based target. If you want to get a feeling of |main_project_name| on a real hardware, checkout one of the :ref:`supported boards <SupportedBoards>`.

Contents

• Prerequisites
• Clone Build System Repositories
• Building an Oniro image
• Building with OpenHarmony compatibility
• Booting a Qemu X86-64 Target with a |main_project_name| image

Prerequisites

Install all the required host packages. Here is an example for Ubuntu:

$ sudo apt-get install gawk wget git diffstat unzip texinfo gcc-multilib \
  build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
  xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \
  pylint3 xterm file zstd

See official Yocto documentation for host package requirements on all supported Linux distributions.

Clone Build System Repositories

Install Google git repo tool. For example, on Ubuntu 20.04, you can do this by:

$ sudo add-apt-repository ppa:ostc/ppa
$ sudo apt-get update
$ sudo apt-get install git-repo

Initialize a repo workspace and clone all required repositories:

$ mkdir oniroproject; cd oniroproject
$ repo init -u https://gitlab.eclipse.org/eclipse/oniro-core/oniro.git -b kirkstone
$ repo sync --no-clone-bundle

Building an Oniro image

The following steps will build a oniro-image-base. The process will build all its components, including the toolchain, from source.

First of all change directory into the one where the build repositories were cloned using the repo tool. See above.

Note

Depending on the configuration type, a single |main_project_name| build could use around 100GB of disk space for downloads, temporary files, and build artifacts combined.

Initialize the build directory and run a build:

$ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux
$ MACHINE=qemux86-64 bitbake oniro-image-base

Building with OpenHarmony compatibility

To enable OpenHarmony compatibility, before running the last bitbake command in the section above, you have to add the following to build-oniro-linux/conf/local.conf file:

TOOLCHAIN="clang"
RUNTIME="llvm"
DISTRO_FEATURES:append = " openharmony"
IMAGE_INSTALL:append = " openharmony-standard"

This will enable OpenHarmony features and add OpenHarmony Standard System features to the oniro-image-base image.

With that in place, the image can be built with the instructions in the :ref:`Building an Oniro image <Building an Oniro image>` section above.

Booting a Qemu X86-64 Target with a |main_project_name| image

Once the image is built, you can run a Qemu X86-64 instance using the provided script wrapper as follows:

$ MACHINE=qemux86-64 runqemu oniro-image-base wic ovmf slirp

If the host has a VT-capable CPU, you can pass the kvm argument for better performance. Check runqemu's help message for all available arguments.

The default user name is oniro with oniro as a password.