From fc99fc952e63e7a90545004c7e09de175a57f051 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 18 May 2018 09:50:10 -0700 Subject: sdk-manual: Minor edits to the intro chapter. (From yocto-docs rev: 706b4adfd925d247da2ce7405f12ce1e05666a9e) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/sdk-manual/sdk-intro.xml | 67 ++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 27 deletions(-) (limited to 'documentation/sdk-manual/sdk-intro.xml') diff --git a/documentation/sdk-manual/sdk-intro.xml b/documentation/sdk-manual/sdk-intro.xml index ead450112c..8642be61ad 100644 --- a/documentation/sdk-manual/sdk-intro.xml +++ b/documentation/sdk-manual/sdk-intro.xml @@ -31,15 +31,18 @@ All SDKs consist of the following: - Cross-Development Toolchain: + + Cross-Development Toolchain: This toolchain contains a compiler, debugger, and various miscellaneous tools. - Libraries, Headers, and Symbols: + + Libraries, Headers, and Symbols: The libraries, headers, and symbols are specific to the image (i.e. they match the image). - Environment Setup Script: + + Environment Setup Script: This *.sh file, once run, sets up the cross-development environment by defining variables and preparing for SDK use. @@ -48,7 +51,7 @@ - Additionally an extensible SDK has tools that allow you to easily add + Additionally, an extensible SDK has tools that allow you to easily add new applications and libraries to an image, modify the source of an existing component, test changes on the target hardware, and easily integrate an application into the @@ -81,14 +84,15 @@ and LD. This reduces the space needed for the tools. - Understand, however, that a sysroot is still needed for every target - since those binaries are target-specific. + Understand, however, that every target still needs a sysroot because + those binaries are target-specific. The SDK development environment consists of the following: - The self-contained SDK, which is an + + The self-contained SDK, which is an architecture-specific cross-toolchain and matching sysroots (target and native) all built by the OpenEmbedded build system (e.g. the SDK). @@ -100,21 +104,24 @@ Additionally, the extensible SDK contains the devtool functionality. - The Quick EMUlator (QEMU), which lets you simulate + + The Quick EMUlator (QEMU), which lets you simulate target hardware. QEMU is not literally part of the SDK. You must build and include this emulator separately. However, QEMU plays an important role in the development process that revolves around use of the SDK. - The Eclipse IDE Yocto Plug-in. + + The Eclipse IDE Yocto Plug-in. This plug-in is available for you if you are an Eclipse user. In the same manner as QEMU, the plug-in is not literally part of the SDK but is rather available for use as part of the development process. - Various performance-related + + Various performance-related tools that can enhance your development experience. These tools are also separate from the actual SDK but can be @@ -192,11 +199,11 @@ - * Extensible SDK will contain the toolchain and debugger if SDK_EXT_TYPE is "full" or SDK_INCLUDE_TOOLCHAIN is "1", which is the default. + * Extensible SDK contains the toolchain and debugger if SDK_EXT_TYPE is "full" or SDK_INCLUDE_TOOLCHAIN is "1", which is the default. - ** Sysroot is managed through use of devtool. Thus, it is less likely that you will corrupt your SDK sysroot when you try to add additional libraries. + ** Sysroot is managed through the use of devtool. Thus, it is less likely that you will corrupt your SDK sysroot when you try to add additional libraries. - *** Runtime package management can be added to the standard SDK but it is not supported by default. + *** You can add runtime package management to the standard SDK but it is not supported by default. **** You must build and make the shared state available to extensible SDK users for "packages" you want to enable users to install. @@ -216,7 +223,7 @@ This toolchain is created by running a SDK installer script or through a Build Directory - that is based on your Metadata configuration or extension for + that is based on your metadata configuration or extension for your targeted device. The cross-toolchain works with a matching target sysroot. @@ -230,7 +237,7 @@ for generating binaries that run on the target architecture. The target sysroot is based on the target root filesystem image that is built by the OpenEmbedded build system and uses the same - Metadata configuration used to build the cross-toolchain. + metadata configuration used to build the cross-toolchain. @@ -240,7 +247,8 @@ The QEMU emulator allows you to simulate your hardware while running your application or image. - QEMU is not part of the SDK but is made available a number of ways: + QEMU is not part of the SDK but is made available a number of + different ways: If you have cloned the poky Git @@ -335,14 +343,18 @@ You just need to follow these general steps: - Install the SDK for your target hardware: + + Install the SDK for your target hardware: For information on how to install the SDK, see the "Installing the SDK" - section. - Download or Build the Target Image: + section. + + + Download or Build the Target Image: The Yocto Project supports several target architectures and has many pre-built kernel images and root filesystem images. + If you are going to develop your application on hardware, go to the machines @@ -356,6 +368,7 @@ so forth. Be sure to get the files you need for your particular development process. + If you are going to develop your application and then run and test it using the QEMU emulator, go to the machines/qemu @@ -364,21 +377,21 @@ target architecture (e.g. qemux86_64 for an Intel-based 64-bit architecture). - Download kernel, root filesystem, and any other files you + Download the kernel, root filesystem, and any other files you need for your process. - To use the root filesystem in QEMU, you - need to extract it. + To use the root filesystem in QEMU, you need to extract it. See the "Extracting the Root Filesystem" section for information on how to extract the root filesystem. - Develop and Test your Application: + + Develop and Test your Application: At this point, you have the tools to develop your application. - If you need to separately install and use the QEMU - emulator, you can go to + If you need to separately install and use the QEMU emulator, + you can go to QEMU Home Page to download and learn about the emulator. See the @@ -391,8 +404,8 @@ - The remainder of this manual describes how to use both the standard - SDK and the extensible SDK. + The remainder of this manual describes how to use the extensible + and standard SDKs. Information also exists in appendix form that describes how you can build, install, and modify an SDK. -- cgit v1.2.3-54-g00ecf