From 90dfac064fab79cc902d611a07432f6411b84095 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 17 Mar 2014 08:45:10 -0600 Subject: dev-manual: General edits to the getting started chapter. Did a read-through of this chapter in preparation for the YP 1.6 release. Found several little areas that needed attention. (From yocto-docs rev: 73d56a4c948c675afd4cde0e3321a944a02013cf) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-start.xml | 59 +++++++++++++++------------ 1 file changed, 33 insertions(+), 26 deletions(-) diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 997ae035cd..05cb8fc9d9 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -81,14 +81,15 @@ them for the supported distributions. Yocto Project Release: - You need a release of the Yocto Project installed locally on + You need a release of the Yocto Project locally installed on your development system. - This local area is referred to as the - Source Directory - and is created when you use + The documentation refers to this set of locally installed files + as the Source Directory. + You create your Source Directory by using Git to clone a local copy of the upstream poky repository, - or when you download an official release of the corresponding tarball. + or by downloading and unpacking a tarball of an official + Yocto Project release. Working from a copy of the upstream repository allows you to contribute back into the Yocto Project or simply work with the latest software on a development branch. @@ -110,18 +111,19 @@ $ git clone git://git.yoctoproject.org/poky Cloning into 'poky'... - remote: Counting objects: 203728, done. - remote: Compressing objects: 100% (52371/52371), done. - remote: Total 203728 (delta 147444), reused 202891 (delta 146614) - Receiving objects: 100% (203728/203728), 95.54 MiB | 308 KiB/s, done. - Resolving deltas: 100% (147444/147444), done. + remote: Counting objects: 226790, done. + remote: Compressing objects: 100% (57465/57465), done. + remote: Total 226790 (delta 165212), reused 225887 (delta 164327) + Receiving objects: 100% (226790/226790), 100.98 MiB | 263 KiB/s, done. + Resolving deltas: 100% (165212/165212), done. For another example of how to set up your own local Git repositories, see this - wiki page, which describes how to create both - poky and meta-intel - Git repositories. + wiki page, which describes how to create local + Git repositories for both + poky and meta-intel. + Yocto Project Kernel: If you are going to be making modifications to a supported Yocto Project kernel, you need to establish local copies of the source. @@ -132,7 +134,7 @@ copying that cloned repository. You can create the bare clone and the copy of the bare clone anywhere you like. For simplicity, it is recommended that you create these structures outside of the - Source Directory (usually poky). + Source Directory, which is usually named poky. As an example, the following transcript shows how to create the bare clone of the linux-yocto-3.10 kernel and then create a copy of that clone. @@ -182,7 +184,7 @@ remote: Counting objects: 727, done. remote: Compressing objects: 100% (452/452), done. remote: Total 727 (delta 260), reused 719 (delta 252) - Receiving objects: 100% (727/727), 536.36 KiB | 102 KiB/s, done. + Receiving objects: 100% (727/727), 536.36 KiB | 240 KiB/s, done. Resolving deltas: 100% (260/260), done. Supported Board @@ -227,11 +229,11 @@ $ cd ~/poky $ git clone git://git.yoctoproject.org/meta-intel.git Cloning into 'meta-intel'... - remote: Counting objects: 7366, done. - remote: Compressing objects: 100% (2491/2491), done. - remote: Total 7366 (delta 3997), reused 7299 (delta 3930) - Receiving objects: 100% (7366/7366), 2.31 MiB | 95 KiB/s, done. - Resolving deltas: 100% (3997/3997), done. + remote: Counting objects: 8844, done. + remote: Compressing objects: 100% (2864/2864), done. + remote: Total 8844 (delta 4931), reused 8780 (delta 4867) + Receiving objects: 100% (8844/8844), 2.48 MiB | 264 KiB/s, done. + Resolving deltas: 100% (4931/4931), done. The same wiki page @@ -263,8 +265,12 @@ Make sure you have set up the Source Directory described in the previous section. - Initialize the build environment by sourcing a build environment - script. + Initialize the build environment by sourcing a build + environment script (i.e. + &OE_INIT_FILE; + or + oe-init-build-env-memres). + Optionally ensure the conf/local.conf configuration file, which is found in the Build Directory, @@ -277,10 +283,11 @@ PARALLEL_MAKE variables, and a centralized tarball download directory through the DL_DIR variable. - Build the image using the bitbake command. - If you want information on BitBake, see the user manual included in the - bitbake/doc/manual directory of the - Source Directory. + + Build the image using the bitbake command. + If you want information on BitBake, see the + BitBake User Manual. + Run the image either on the actual hardware or using the QEMU emulator. -- cgit v1.2.3-54-g00ecf