From 0a4f7521bb786b7ac84e3204812a2c76df29c0de Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 4 Oct 2012 10:13:42 -0700 Subject: documentation: dev-manual - Edits to setup part of example Minor edits to the part of the example that sets up for the first core-image-minimal build. Put in the variable to use for the build environment setup script, updated some changed output from some of the commands, etc. (From yocto-docs rev: 0b4b2ddf9a78a9d6d218ed9a6f0acd3e876d9581) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-kernel-appendix.xml | 63 ++++++++++++++++------ documentation/dev-manual/dev-manual-start.xml | 4 +- 2 files changed, 48 insertions(+), 19 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml index 667640c86f..cf5fb4522a 100644 --- a/documentation/dev-manual/dev-manual-kernel-appendix.xml +++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml @@ -76,16 +76,18 @@ Local Source Directory: This area contains all the metadata that supports building images using the OpenEmbedded build system. - In this example, the Source Directory also - contains the build directory, which contains the configuration directory + In this example, the + Source Directory also + contains the + Build Directory, + which contains the configuration directory that lets you control the build. Also in this example, the Source Directory contains local copies of the poky-extras Git repository. See the bulleted item "Yocto Project Release" for information on how to get these files on your local system. - Local copies of thepoky-extras - Git Repository: + Local copies of the poky-extras Git Repository: This area contains the meta-kernel-dev layer, which is where you make changes that append the kernel build recipes. You edit .bbappend files to locate your @@ -132,7 +134,9 @@ Setting Up the Local Source Directory - You can set up the Source Directory through tarball extraction or by + You can set up the + Source Directory + through tarball extraction or by cloning the poky Git repository. This example uses poky as the root directory of the local Source Directory. @@ -179,11 +183,12 @@ Because this example uses the Yocto Project &DISTRO; Release code named "&DISTRO_NAME;", which maps to the &DISTRO_NAME; branch in the repository, you need to be sure you are using that - branch for poky-extra. + branch for poky-extras. The following commands create and checkout the local branch you are using for the &DISTRO_NAME; branch: + $ cd ~/poky/poky-extras $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; Branch &DISTRO_NAME; set up to track remote branch &DISTRO_NAME; from origin. Switched to a new branch '&DISTRO_NAME;' @@ -195,7 +200,7 @@ Setting Up the Bare Clone and its Copy - This example modifies the linux-yocto-3.2 kernel. + This example modifies the linux-yocto-3.4 kernel. Thus, you need to create a bare clone of that kernel and then make a copy of the bare clone. See the bulleted item @@ -207,17 +212,16 @@ The bare clone exists for the kernel build tools and simply as the receiving end of git push commands after you make edits and commits inside the copy of the clone. - The copy (my-linux-yocto-3.2-work in this example) has to have + The copy (my-linux-yocto-3.4-work in this example) has to have a local branch created and checked out for your work. This example uses common-pc-base as the local branch. The following commands create and checkout the branch: - $ cd ~/my-linux-yocto-3.2-work - $ git checkout -b common-pc-base origin/standard/default/common-pc/base - Checking out files: 100% (532/532), done. - Branch common-pc-base set up to track remote branch - standard/default/common-pc/base from origin. - Switched to a new branch 'common-pc-base' + $ cd ~/my-linux-yocto-3.4-work + $ git checkout -b standard-common-pc-base origin/standard/common-pc/base + Branch standard-common-pc-base set up to track remote branch + standard/common-pc/base from origin. + Switched to a new branch 'standard-common-pc-base' @@ -249,11 +253,36 @@ If necessary, the script creates the build directory: $ cd ~/poky - $ source oe-init-build-env + $ source &OE_INIT_FILE; + You had no conf/local.conf file. This configuration file has therefore been + created for you with some default values. You may wish to edit it to use a + different MACHINE (target hardware) or enable parallel build options to take + advantage of multiple cores for example. See the file for more information as + common configuration options are commented. - ### Shell environment set up for builds. ### + The Yocto Project has extensive documentation about OE including a reference manual + which can be found at: + http://yoctoproject.org/documentation - You can now run 'bitbake <target>' + For more information about OpenEmbedded see their website: + http://www.openembedded.org/ + + You had no conf/bblayers.conf file. The configuration file has been created for + you with some default values. To add additional metadata layers into your + configuration please add entries to this file. + + The Yocto Project has extensive documentation about OE including a reference manual + which can be found at: + http://yoctoproject.org/documentation + + For more information about OpenEmbedded see their website: + http://www.openembedded.org/ + + + + ### Shell environment set up for builds. ### + + You can now run 'bitbake <target>>' Common targets are: core-image-minimal diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index f9ec8d1d66..e55a07d87a 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -152,8 +152,8 @@ Now create a clone of the bare clone just created: $ git clone linux-yocto-3.4.git my-linux-yocto-3.4-work - Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.4-work/.git/ - Checking out files: 100% (37619/37619), done. + Cloning into 'my-linux-yocto-3.4-work'... + done. The poky-extras Git Repository: -- cgit v1.2.3-54-g00ecf