From 184166fa7a5e1beb51660258b1d19dd4daa85996 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 12 Nov 2013 11:22:10 -0800 Subject: [PATCH] dev-manual: Fixed broken structure. I discovered that the dev-manual was not making correctly. Probably resulted in trying to merge in some of Robert P. J. Day's comments. I have made the tag changes to fix this. Also, I added back in the two methods for setting up meta-intel as I am not making the tarball-exclusion changes to the dora branch. (From yocto-docs rev: a10a9c3960045a777da6245a2502504f15fad579) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-start.xml | 136 +++++++++++------- 1 file changed, 86 insertions(+), 50 deletions(-) diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 5e8195c8b0..c1d89bc7b9 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -57,8 +57,8 @@ Here is what you need to use the Yocto Project: - Host System: You should have a reasonably current - Linux-based host system. + Host System: + You should have a reasonably current Linux-based host system. You will have the best results with a recent release of Fedora, openSUSE, Debian, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project and officially supported. @@ -69,15 +69,15 @@ You should also have about 100 gigabytes of free disk space for building images. - Packages: The OpenEmbedded build system - requires that certain packages exist on your development system (e.g. Python 2.6 or 2.7). + Packages: + The OpenEmbedded build system requires that certain packages + exist on your development system (e.g. Python 2.6 or 2.7). See "The Packages" section in the Yocto Project Quick Start and the "Required Packages for the Host Development System" section in the Yocto Project Reference Manual for the exact package requirements and the installation commands to install - them for the supported distributions. - + them for the supported distributions. Yocto Project Release: You need a release of the Yocto Project installed locally on your development system. @@ -86,7 +86,8 @@ and is created when you use Git to clone a local copy of the upstream poky repository, - or when you download an official release of the corresponding tarball. + or when you download an official release of the corresponding + tarball. 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. @@ -94,7 +95,7 @@ a complete history of changes and you are working with a local clone of that repository, you have access to all the Yocto Project development branches and tag names used in the upstream - repository. + repository. You can view the Yocto Project Source Repositories at @@ -108,27 +109,40 @@ directory of your choice. For example, the following command extracts the Yocto Project &DISTRO; release tarball - into the current working directory and sets up the local Source Directory - with a top-level folder named &YOCTO_POKY;: + into the current working directory and sets up the local + Source Directory + with a top-level folder named + &YOCTO_POKY;: $ tar xfj &YOCTO_POKY_TARBALL; - This method does not produce a local Git repository. - Instead, you simply end up with a snapshot of the release. - Git Repository Method: If you are going to be contributing - back into the Yocto Project or you simply want to keep up - with the latest developments, you should use Git commands to set up a local - Git repository of the upstream poky source repository. - Doing so creates a repository with a complete history of changes and allows - you to easily submit your changes upstream to the project. - Because you clone the repository, you have access to all the Yocto Project development - branches and tag names used in the upstream repository. - You can view the Yocto Project Source Repositories at - - The following transcript shows how to clone the poky - Git repository into the current working directory. - The command creates the local repository in a directory named poky. - For information on Git used within the Yocto Project, see the + This method does not produce a local Git + repository. + Instead, you simply end up with a snapshot of the + release. + Git Repository Method: + If you are going to be contributing back into the Yocto + Project or you simply want to keep up with the latest + developments, you should use Git commands to set up a + local Git repository of the upstream + poky source repository. + Doing so creates a repository with a complete history + of changes and allows you to easily submit your changes + upstream to the project. + Because you clone the repository, you have access to all + the Yocto Project development branches and tag names + used in the upstream repository. + You can view the Yocto Project Source Repositories + at + + + The following transcript shows how to clone the + poky Git repository into the + current working directory. + The command creates the local repository in a directory + named poky. + For information on Git used within the Yocto Project, + see the "Git" section. $ git clone git://git.yoctoproject.org/poky @@ -138,11 +152,14 @@ 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. - - 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. + + 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. + Yocto Project Kernel: If you are going to be making modifications to a supported Yocto Project kernel, you @@ -166,7 +183,7 @@ linux-yocto-3.10.git, while the copy is named my-linux-yocto-3.10-work: - $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.10 linux-yocto-3.10.git + $ git clone ‐‐bare git://git.yoctoproject.org/linux-yocto-3.10 linux-yocto-3.10.git Cloning into bare repository 'linux-yocto-3.10.git'... remote: Counting objects: 3364487, done. remote: Compressing objects: 100% (507178/507178), done. @@ -233,20 +250,39 @@ See the "BSP Layers" section in the Yocto Project Board Support Package (BSP) - Developer's Guide for more information on BSP Layers. - You can locate the meta-intel Git - repository in the "Yocto Metadata Layers" area of the Yocto - Project Source Repositories at - . - Using - Git to create a local clone of the - upstream repository can be helpful if you are working with - BSPs. - Typically, you set up the meta-intel - Git repository inside the Source Directory. - For example, the following transcript shows the steps to clone - meta-intel. - + Developer's Guide for more information on BSP Layers. + + Tarball Extraction: + You can download any released BSP tarball from the same + "Downloads" page of the Yocto Project + Website + to get the Yocto Project release. + Once on the "Download" page, look to the right of the + page and scroll down to find the BSP tarballs. + Once you have the tarball, just extract it into a + directory of your choice. + Again, this method just produces a snapshot of the BSP + layer in the form of a hierarchical directory + structure. + Git Repository Method: + If you are working with a local Git repository for your + Source Directory, you should also use this method to + set up the meta-intel Git + repository. + You can locate the meta-intel Git + repository in the "Yocto Metadata Layers" area of the + Yocto Project Source Repositories at + . + Using + Git to create a local clone + of the upstream repository can be helpful if you are + working with BSPs. + Typically, you set up the + meta-intel Git repository inside + the Source Directory. + For example, the following transcript shows the steps + to clone meta-intel. + $ cd ~/poky $ git clone git://git.yoctoproject.org/meta-intel.git Cloning into 'meta-intel'... @@ -255,12 +291,12 @@ 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. - - The same + + The same wiki page referenced earlier covers how to - set up the meta-intel Git repository. - + set up the meta-intel Git + repository. Eclipse Yocto Plug-in: If you are developing applications using the Eclipse Integrated Development Environment (IDE),