From 2f25c9b56c84b9999dadec52088d2e95787d8e36 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 28 Jul 2017 16:40:30 -0700 Subject: yocto-project-qs: Added section for CROPS. (From yocto-docs rev: 0d6fba532e0247db2cce4e94466f4476114d3e13) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../yocto-project-qs/yocto-project-qs.xml | 418 +++++++++++++-------- 1 file changed, 253 insertions(+), 165 deletions(-) (limited to 'documentation') diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 6064f96cc4..9eaaea5501 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -44,7 +44,6 @@ - Setting Up to Use the Yocto Project - The following list shows what you need in order to use a - Linux-based build host to use the Yocto Project to build images: + Setting up to use the Yocto Project involves getting your build + host ready. + If you have a native Linux machine that runs a Yocto Project + supported distribution as described by the + "Supported Linux Distributions" + section in the Yocto Project Reference Manual, you can prepare + that machine as your build host. + See the + "Using a Native Linux Machine" + section for more information. - - Build Host - A build host with a minimum of 50 Gbytes of free disk - space that is running a supported Linux distribution (i.e. - recent releases of Fedora, openSUSE, CentOS, Debian, or - Ubuntu). - - Build Host Packages - Appropriate packages installed on the build host. - - The Yocto Project - A release of the Yocto Project. - - - -
- The Linux Distribution + + If you do not want to use the Yocto Project on a native Linux + machine, you can prepare your build host to use + CROPS, + which leverages + Docker Containers. + You can set up a build host for Windows, Mac, and Linux + machines. + See the + "Using CROPS and Containers" + section for more information. + - - The Yocto Project team verifies each release against recent - versions of the most popular Linux distributions that - provide stable releases. - In general, if you have the current release minus one of the - following distributions, you should have no problems. - - - Ubuntu - - - Fedora - - - openSUSE - - - CentOS - - - Debian - - - For a more detailed list of distributions that support the - Yocto Project, see the - "Supported Linux Distributions" - section in the Yocto Project Reference Manual. - +
+ Using CROPS and Containers - The OpenEmbedded build system should be able to run on any - modern distribution that has the following versions for - Git, tar, and Python. - - - Git 1.8.3.1 or greater - + Follow these steps to get your build host set up with a + Poky container that you can use to complete the build + examples further down in the Quick Start: + - tar 1.27 or greater + Reference the Procedure: + Work through the first six steps of the procedure + in the + "Setting Up to Use CROss PlatformS (CROPS)" + section of the Yocto Project Development Manual. - Python 3.4.0 or greater. + Set Up the Poky Container to Use the Yocto Project: + Go to + + and follow the directions to set up the Poky container + on your build host. + + Once you complete the setup instructions for your + machine, you need to get a copy of the + poky repository on your build + host. + See the + "Yocto Project Release" + section to continue. - - If your build host does not meet any of these three listed - version requirements, you can take steps to prepare the - system so that you can still use the Yocto Project. - See the - "Required Git, tar, and Python Versions" - section in the Yocto Project Reference Manual for information. +
-
- The Build Host Packages +
+ Using a Native Linux Machine - Required build host packages vary depending on your - build machine and what you want to do with the Yocto Project. - For example, if you want to build an image that can run - on QEMU in graphical mode (a minimal, basic build - requirement), then the build host package requirements - are different than if you want to build an image on a headless - system or build out the Yocto Project documentation set. + The following list shows what you need in order to use a + Linux-based build host to use the Yocto Project to build images: - - Collectively, the number of required packages is large - if you want to be able to cover all cases. - - In general, you need to have root access and then install - the required packages. - Thus, the commands in the following section may or may - not work depending on whether or not your Linux - distribution has sudo installed. - - + + Build Host + A build host with a minimum of 50 Gbytes of free disk + space that is running a supported Linux distribution (i.e. + recent releases of Fedora, openSUSE, CentOS, Debian, or + Ubuntu). + + Build Host Packages + Appropriate packages installed on the build host. + + - - The following list shows the required packages needed to build - an image that runs on QEMU in graphical mode (e.g. essential - plus graphics support). - For lists of required packages for other scenarios, see the - "Required Packages for the Host Development System" - section in the Yocto Project Reference Manual. - - Ubuntu and Debian - +
+ The Linux Distribution + + + The Yocto Project team verifies each release against recent + versions of the most popular Linux distributions that + provide stable releases. + In general, if you have the current release minus one of the + following distributions, you should have no problems. + + + Ubuntu + + + Fedora + + + openSUSE + + + CentOS + + + Debian + + + For a more detailed list of distributions that support the + Yocto Project, see the + "Supported Linux Distributions" + section in the Yocto Project Reference Manual. + + + + The OpenEmbedded build system should be able to run on any + modern distribution that has the following versions for + Git, tar, and Python. + + + Git 1.8.3.1 or greater + + + tar 1.27 or greater + + + Python 3.4.0 or greater. + + + If your build host does not meet any of these three listed + version requirements, you can take steps to prepare the + system so that you can still use the Yocto Project. + See the + "Required Git, tar, and Python Versions" + section in the Yocto Project Reference Manual for information. + +
+ +
+ The Build Host Packages + + + Required build host packages vary depending on your + build machine and what you want to do with the Yocto Project. + For example, if you want to build an image that can run + on QEMU in graphical mode (a minimal, basic build + requirement), then the build host package requirements + are different than if you want to build an image on a headless + system or build out the Yocto Project documentation set. + + + + Collectively, the number of required packages is large + if you want to be able to cover all cases. + + In general, you need to have root access and then install + the required packages. + Thus, the commands in the following section may or may + not work depending on whether or not your Linux + distribution has sudo installed. + + + + + The following list shows the required packages needed to build + an image that runs on QEMU in graphical mode (e.g. essential + plus graphics support). + For lists of required packages for other scenarios, see the + "Required Packages for the Host Development System" + section in the Yocto Project Reference Manual. + + Ubuntu and Debian + $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; libsdl1.2-dev xterm - - - Fedora - + + + Fedora + $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm - - - OpenSUSE - + + + OpenSUSE + $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; libSDL-devel xterm - - - CentOS - + + + CentOS + $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm - - Notes - - - CentOS 6.x users need to ensure that the - required versions of Git, tar and Python - are available. - For details, See the - "Required Git, tar, and Python Versions" - section in the Yocto Project Reference - Manual for information. - - - Extra Packages for Enterprise Linux - (i.e. epel-release) - is a collection of packages from Fedora - built on RHEL/CentOS for easy installation - of packages not included in enterprise - Linux by default. - You need to install these packages - separately. - - - The makecache command - consumes additional Metadata from - epel-release. - - - - - + + Notes + + + CentOS 6.x users need to ensure that the + required versions of Git, tar and Python + are available. + For details, See the + "Required Git, tar, and Python Versions" + section in the Yocto Project Reference + Manual for information. + + + Extra Packages for Enterprise Linux + (i.e. epel-release) + is a collection of packages from Fedora + built on RHEL/CentOS for easy installation + of packages not included in enterprise + Linux by default. + You need to install these packages + separately. + + + The makecache command + consumes additional Metadata from + epel-release. + + + + + + +
+ + + Once you complete the setup instructions for your + machine, you need to get a copy of the + poky repository on your build + host. + Continue with the + "Yocto Project Release" + section.
@@ -344,8 +414,9 @@ Yocto Project Release - The last requirement you need to meet before using the - Yocto Project is getting a Yocto Project release. + Now that your build host has the right packages (native + Linux machine) or you have the Poky container set up + (CROPS), you need to get a copy of the Yocto Project. It is recommended that you get the latest Yocto Project release by setting up (cloning in Git terms) a @@ -356,9 +427,14 @@ - Here is an example from an Ubuntu build host that clones the - poky repository and then checks out the - latest Yocto Project Release by tag + Here is an example from a native Linux machine that is + running Ubuntu. + + If your build host is using a Poky container, you can + use the same Git commands. + + The example clones the poky repository + and then checks out the latest Yocto Project Release by tag (i.e. &DISTRO_REL_TAG;): $ git clone git://git.yoctoproject.org/poky @@ -404,20 +480,21 @@ Building Images - Now that you have your system requirements in order, you can give - Yocto Project a try. - You can try out Yocto Project using either the command-line - interface or using Toaster, which uses a graphical user - interface. - If you want to try out the Yocto Project using a GUI, see the - Toaster User Manual - for information on how to install and set up Toaster. + You are now ready to give the Yocto Project a try. + For this example, you will be using the command line to build + your images. + + A graphical user interface to the Yocto Project is available + through Toaster. + See the + Toaster User Manual + for more information. + - To use the Yocto Project through the command-line interface, - finish this quick start, which presents steps that let you - do the following: + The remainder of this quick start steps you through the + following: Build a qemux86 reference image @@ -477,7 +554,8 @@ - Be Sure Your Build Host is Set Up: + + Be Sure Your Build Host is Set Up: The steps to build an image in this section depend on your build host being properly set up. Be sure you have worked through the requirements @@ -485,7 +563,8 @@ "Setting Up to Use the Yocto Project" section. - Check Out Your Branch: + + Check Out Your Branch: Be sure you are in the Source Directory (e.g. poky) and then check out @@ -505,7 +584,8 @@ branch ensures you are using the latest files for that release. - Initialize the Build Environment: + + Initialize the Build Environment: Run the &OE_INIT_FILE; environment setup script to define the OpenEmbedded @@ -530,7 +610,8 @@ setup script. - Examine Your Local Configuration File: + + Examine Your Local Configuration File: When you set up the build environment, a local configuration file named local.conf becomes available in @@ -584,7 +665,8 @@ - Start the Build: + + Start the Build: Continue with the following command to build an OS image for the target, which is core-image-sato in this example: @@ -642,7 +724,8 @@ "Images" chapter in the Yocto Project Reference Manual. - Simulate Your Image Using QEMU: + + Simulate Your Image Using QEMU: Once this particular image is built, you can start QEMU and run the image: @@ -652,7 +735,8 @@ "Using the Quick EMUlator (QEMU)" chapter in the Yocto Project Development Manual. - Exit QEMU: + + Exit QEMU: Exit QEMU by either clicking on the shutdown icon or by typing Ctrl-C in the QEMU transcript window from which you evoked QEMU. @@ -682,7 +766,8 @@ - Create a Local Copy of the + + Create a Local Copy of the meta-intel Repository: Building an image for the MinnowBoard Turbot requires the @@ -731,7 +816,8 @@ "meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;" in the above example. - Configure the Build: + + Configure the Build: To configure the build, you edit the bblayers.conf and local.conf files, both of which are @@ -836,7 +922,8 @@ tmp/deploy/images/intel-corei7-64/core-image-base-intel-corei7-64.wic - Write the Image: + + Write the Image: You can write the image just built to a bootable media (e.g. a USB key, SATA drive, SD card, etc.) using the dd utility: @@ -850,7 +937,8 @@ /dev/mmcblk0, which is most likely an SD card). - Boot the Hardware: + + Boot the Hardware: With the boot device provisioned, you can insert the media into the MinnowBoard Turbot and boot the hardware. The board should automatically detect the media and boot to @@ -914,7 +1002,7 @@ extensible SDK, which are used primarily for application development. This manual also provides example workflows - that use the popular Eclipse + that use the popular Eclipse development environment and that use devtool. See the "Workflow using Eclipse™" -- cgit v1.2.3-54-g00ecf