Yocto Project Application Development and the Extensible Software Development Kit (eSDK)

The Yocto Project

Copyright © 2010-2020, The Linux Foundation

<docs@lists.yoctoproject.org>

Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons.

Note

• This version of this manual is for the 3.1 release of the Yocto Project. To be sure you have the latest version of the manual for this release, go to the Yocto Project documentation page and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files.

• If you located this manual through a web search, the version of the manual might not be the one you want (e.g. the search might have returned a manual much older than the Yocto Project version with which you are working). You can see all Yocto Project major releases by visiting the Releases page. If you need a version of this manual for a different Yocto Project release, visit the Yocto Project documentation page and select the manual set by using the “ACTIVE RELEASES DOCUMENTATION” or “DOCUMENTS ARCHIVE” pull-down menus.

• To report any inaccuracies or problems with this (or any other Yocto Project) manual, send an email to the Yocto Project documentation mailing list at docs@lists.yoctoproject.org or log into the freenode #yocto channel.

Revision	Date	Note
2.1	April 2016	The initial document released with the Yocto Project 2.1 Release
2.2	October 2016	Released with the Yocto Project 2.2 Release.
2.3	May 2017	Released with the Yocto Project 2.3 Release.
2.4	October 2017	Released with the Yocto Project 2.4 Release.
2.5	May 2018	Released with the Yocto Project 2.5 Release.
2.6	November 2018	Released with the Yocto Project 2.6 Release.
2.7	May 2019	Released with the Yocto Project 2.7 Release.
3.0	October 2019	Released with the Yocto Project 3.0 Release.
3.1	April 2020	Released with the Yocto Project 3.1 Release.

Table of Contents

• 1. Introduction
  • 1.1. Introduction
    • 1.1.1. The Cross-Development Toolchain
    • 1.1.2. Sysroots
    • 1.1.3. The QEMU Emulator
  • 1.2. SDK Development Model
• 2. Using the Extensible SDK
  • 2.1. Why use the Extensible SDK and What is in It?
  • 2.2. Installing the Extensible SDK
  • 2.3. Running the Extensible SDK Environment Setup Script
  • 2.4. Using devtool in Your SDK Workflow
    • 2.4.1. Use devtool add to Add an Application
    • 2.4.2. Use devtool modify to Modify the Source of an Existing Component
    • 2.4.3. Use devtool upgrade to Create a Version of the Recipe that Supports a Newer Version of the Software
  • 2.5. A Closer Look at devtool add
    • 2.5.1. Name and Version
    • 2.5.2. Dependency Detection and Mapping
    • 2.5.3. License Detection
    • 2.5.4. Adding Makefile-Only Software
    • 2.5.5. Adding Native Tools
    • 2.5.6. Adding Node.js Modules
  • 2.6. Working With Recipes
    • 2.6.1. Finding Logs and Work Files
    • 2.6.2. Setting Configure Arguments
    • 2.6.3. Sharing Files Between Recipes
    • 2.6.4. Packaging
  • 2.7. Restoring the Target Device to its Original State
  • 2.8. Installing Additional Items Into the Extensible SDK
  • 2.9. Applying Updates to an Installed Extensible SDK
  • 2.10. Creating a Derivative SDK With Additional Components
• 3. Using the Standard SDK
  • 3.1. Why use the Standard SDK and What is in It?
  • 3.2. Installing the SDK
  • 3.3. Running the SDK Environment Setup Script
• 4. Using the SDK Toolchain Directly
  • 4.1. Autotools-Based Projects
  • 4.2. Makefile-Based Projects
• 5. Obtaining the SDK
  • 5.1. Locating Pre-Built SDK Installers
  • 5.2. Building an SDK Installer
  • 5.3. Extracting the Root Filesystem
  • 5.4. Installed Standard SDK Directory Structure
  • 5.5. Installed Extensible SDK Directory Structure
• 6. Customizing the Extensible SDK
  • 6.1. Configuring the Extensible SDK
  • 6.2. Adjusting the Extensible SDK to Suit Your Build Host’s Setup
  • 6.3. Changing the Extensible SDK Installer Title
  • 6.4. Providing Updates to the Extensible SDK After Installation
  • 6.5. Changing the Default SDK Installation Directory
  • 6.6. Providing Additional Installable Extensible SDK Content
  • 6.7. Minimizing the Size of the Extensible SDK Installer Download
• 7. Customizing the Standard SDK
  • 7.1. Adding Individual Packages to the Standard SDK
  • 7.2. Adding API Documentation to the Standard SDK