From 94b786bf91ed5ed655ae4c4543ba3a81faa9d583 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 9 Apr 2013 10:53:46 -0700 Subject: dev-manual: Updates to "Getting Set Up" section. Updated the transcripts used to set things up. I also changed the kernel used in the examples from 3.4 to 3.8. (From yocto-docs rev: d83e5a5a73777baf95b5c4558f25a5b0b27c204c) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-start.xml | 102 ++++++++++++++------------ 1 file changed, 54 insertions(+), 48 deletions(-) (limited to 'documentation/dev-manual/dev-manual-start.xml') diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index c4d91fff84..42a6e82c88 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -72,9 +72,12 @@ Packages: The OpenEmbedded build system requires 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 for the exact package - requirements and the installation commands to install them - for the supported distributions. + 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. + Yocto Project Release: You need a release of the Yocto Project. You set that up with a local Source Directory @@ -85,12 +88,15 @@ hierarchical set of files as the "Source Directory." - Tarball Extraction: If you are not going to contribute - back into the Yocto Project, you can simply download a Yocto Project release you want - from the website’s download page. - Once you have the tarball, just extract it into a directory of your choice. - For example, the following command extracts the Yocto Project &DISTRO; - release tarball + Tarball Extraction: + If you are not going to contribute back into the Yocto + Project, you can simply go to the + Yocto Project Website, + select the "Downloads" tab, and choose what you want. + Once you have the tarball, just extract it into a + 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;: @@ -104,23 +110,23 @@ 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 cloned the repository, you have access to all the Yocto Project development + Because you clone the repository, you have access to all the Yocto Project development branches and tag names used in the upstream repository. - The following transcript shows how to clone the poky - Git repository into the current working directory. 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 - Initialized empty Git repository in /home/scottrif/poky/.git/ - remote: Counting objects: 141863, done. - remote: Compressing objects: 100% (38624/38624), done. - remote: Total 141863 (delta 99661), reused 141816 (delta 99614) - Receiving objects: 100% (141863/141863), 76.64 MiB | 126 KiB/s, done. - Resolving deltas: 100% (99661/99661), done. + Cloning into 'poky'... + remote: Counting objects: 183981, done. + remote: Compressing objects: 100% (47428/47428), done. + remote: Total 183981 (delta 132271), reused 183703 (delta 132044) + Receiving objects: 100% (183981/183981), 89.71 MiB | 2.93 MiB/s, done. + Resolving deltas: 100% (132271/132271), done. For another example of how to set up your own local Git repositories, see this @@ -139,33 +145,32 @@ For simplicity, it is recommended that you create these structures outside of the Source Directory (usually poky). As an example, the following transcript shows how to create the bare clone - of the linux-yocto-3.4 kernel and then create a copy of + of the linux-yocto-3.8 kernel and then create a copy of that clone. When you have a local Yocto Project kernel Git repository, you can reference that repository rather than the upstream Git repository as part of the clone command. Doing so can speed up the process. In the following example, the bare clone is named - linux-yocto-3.4.git, while the - copy is named my-linux-yocto-3.4-work: + linux-yocto-3.8.git, while the + copy is named my-linux-yocto-3.8-work: - $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.4 linux-yocto-3.4.git - Initialized empty Git repository in /home/scottrif/linux-yocto-3.4.git/ - remote: Counting objects: 2468027, done. - remote: Compressing objects: 100% (392255/392255), done. - remote: Total 2468027 (delta 2071693), reused 2448773 (delta 2052498) - Receiving objects: 100% (2468027/2468027), 530.46 MiB | 129 KiB/s, done. - Resolving deltas: 100% (2071693/2071693), done. - + $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.8 linux-yocto-3.8.git + Cloning into bare repository 'linux-yocto-3.8.git'... + remote: Counting objects: 2847090, done. + remote: Compressing objects: 100% (454675/454675), done. + remote: Total 2847090 (delta 2386170), reused 2825793 (delta 2364886) + Receiving objects: 100% (2847090/2847090), 603.19 MiB | 3.54 MiB/s, done. + Resolving deltas: 100% (2386170/2386170), done. Now create a clone of the bare clone just created: - $ git clone linux-yocto-3.4.git my-linux-yocto-3.4-work - Cloning into 'my-linux-yocto-3.4-work'... + $ git clone linux-yocto-3.8.git my-linux-yocto-3.8-work + Cloning into 'my-linux-yocto-3.8-work'... done. The poky-extras Git Repository: - The poky-extras Git repository contains metadata needed + The poky-extras Git repository contains Metadata needed only if you are modifying and building the kernel image. In particular, it contains the kernel BitBake append (.bbappend) files that you @@ -183,13 +188,12 @@ $ cd ~/poky $ git clone git://git.yoctoproject.org/poky-extras poky-extras - Initialized empty Git repository in /home/scottrif/poky/poky-extras/.git/ - remote: Counting objects: 618, done. - remote: Compressing objects: 100% (558/558), done. - remote: Total 618 (delta 192), reused 307 (delta 39) - Receiving objects: 100% (618/618), 526.26 KiB | 111 KiB/s, done. - Resolving deltas: 100% (192/192), done. - + Cloning into 'poky-extras'... + remote: Counting objects: 690, done. + remote: Compressing objects: 100% (431/431), done. + remote: Total 690 (delta 238), reused 690 (delta 238) + Receiving objects: 100% (690/690), 532.60 KiB, done. + Resolving deltas: 100% (238/238), done. Supported Board Support Packages (BSPs): The Yocto Project provides a layer called meta-intel and @@ -219,10 +223,12 @@ information on BSP Layers. Tarball Extraction: You can download any released - BSP tarball from the same - download site used + BSP tarball from the same "Downloads" page of the + Yocto Project Website to get the Yocto Project release. - Once you have the tarball, just extract it into a directory of your choice. + Once on the "Download" page, look for "BSP" under the + "Type" heading. + 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 @@ -239,12 +245,12 @@ $ cd ~/poky $ git clone git://git.yoctoproject.org/meta-intel.git - Initialized empty Git repository in /home/scottrif/poky/meta-intel/.git/ - remote: Counting objects: 3380, done. - remote: Compressing objects: 100% (2750/2750), done. - remote: Total 3380 (delta 1689), reused 227 (delta 113) - Receiving objects: 100% (3380/3380), 1.77 MiB | 128 KiB/s, done. - Resolving deltas: 100% (1689/1689), done. + Cloning into 'meta-intel'... + remote: Counting objects: 6264, done. + remote: Compressing objects: 100% (2135/2135), done. + remote: Total 6264 (delta 3321), reused 6235 (delta 3293) + Receiving objects: 100% (6264/6264), 2.17 MiB | 2.63 MiB/s, done. + Resolving deltas: 100% (3321/3321), done. The same -- cgit v1.2.3-54-g00ecf