From 7606c30c1915bfa192e5b0d125dc6b6e5e7f1857 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 2 Jul 2012 09:57:20 -0700 Subject: documentation/dev-manual/dev-manual-bsp-appendix.xml: Yocto term scrub Scrubbed the manual for the term "Yocto Project", which has been over-used. I updated occurrances to better represent actual bits rather than generically referring to everything as Yocto Project. (From yocto-docs rev: f70cffeffa0d8863a88783607621bf6f7125d02d) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-bsp-appendix.xml | 43 +++++++++++----------- 1 file changed, 21 insertions(+), 22 deletions(-) (limited to 'documentation/dev-manual/dev-manual-bsp-appendix.xml') diff --git a/documentation/dev-manual/dev-manual-bsp-appendix.xml b/documentation/dev-manual/dev-manual-bsp-appendix.xml index ec8fe1463a..e3f8f7664c 100644 --- a/documentation/dev-manual/dev-manual-bsp-appendix.xml +++ b/documentation/dev-manual/dev-manual-bsp-appendix.xml @@ -23,19 +23,20 @@
- Getting Local Yocto Project Files and BSP Files + Getting Local Source Files and BSP Files - You need to have the Yocto Project files available on your host system. - You can get files through tarball extraction or by cloning the poky - Git repository. + You need to have the source directory + available on your host system. + You can set up this directory through tarball extraction or by cloning the + poky Git repository. The following paragraphs describe both methods. For additional information, see the bulleted item "Yocto Project Release". - As mentioned, one way to get the Yocto Project files is to use Git to clone the + As mentioned, one way to set up the source directory is to use Git to clone the poky repository. These commands create a local copy of the Git repository. By default, the top-level directory of the repository is named poky: @@ -44,8 +45,8 @@ $ cd poky Alternatively, you can start with the downloaded Poky "&DISTRO_NAME;" tarball. - These commands unpack the tarball into a Yocto Project File directory structure. - By default, the top-level directory of the file structure is named + These commands unpack the tarball into a source directory structure. + By default, the top-level directory of the source directory is named &YOCTO_POKY;: $ tar xfj &YOCTO_POKY_TARBALL; @@ -60,8 +61,7 @@ Once you expand the released tarball, you have a snapshot of the Git repository that represents a specific release. - Fundamentally, this is different than having a local copy of the Yocto Project - Git repository. + Fundamentally, this is different than having a local copy of the Poky Git repository. Given the tarball method, changes you make are building on top of a release. With the Git repository method you have the ability to track development and keep changes in revision control. @@ -133,12 +133,12 @@ You need to have the base BSP layer on your development system. - Similar to the local Yocto Project Files, + Similar to the local source directory, you can get the BSP layer in a couple of different ways: download the BSP tarball and extract it, or set up a local Git repository that - has the Yocto Project BSP layers. - You should use the same method that you used to get the local Yocto Project files earlier. + has the BSP layers. + You should use the same method that you used to set up the source directory earlier. See "Getting Setup" for information on how to get the BSP files. @@ -196,8 +196,8 @@ Making a Copy of the Base BSP to Create Your New BSP Layer - Now that you have the local Yocto Project files and the base BSP files, you need to create a - new layer for your BSP. + Now that you have set up the source directory and included the base BSP files, you need to + create a new layer for your BSP. To create your BSP layer, you simply copy the meta-crownbay layer to a new layer. @@ -207,7 +207,7 @@ The name should follow the BSP layer naming convention, which is meta-<name>. The following assumes your working directory is meta-intel - inside the local Yocto Project files. + inside your source directory. To start your new layer, just copy the new layer alongside the existing BSP layers in the meta-intel directory: @@ -239,7 +239,7 @@ First, since in this example the new BSP will not support EMGD, we will get rid of the crownbay.conf file and then rename the crownbay-noemgd.conf file to mymachine.conf. - Much of what we do in the configuration directory is designed to help the Yocto Project + Much of what we do in the configuration directory is designed to help the OpenEmbedded build system work with the new layer and to be able to find and use the right software. The following two commands result in a single machine configuration file named mymachine.conf. @@ -312,7 +312,7 @@ When you create a BSP, you use these areas for appropriate recipes and append files. Recipes take the form of .bb files, while append files take the form of .bbappend files. - If you want to leverage the existing recipes the Yocto Project build system uses + If you want to leverage the existing recipes the OpenEmbedded build system uses but change those recipes, you can use .bbappend files. All new recipes and append files for your layer must go in the layer’s recipes-bsp, recipes-kernel, @@ -365,7 +365,7 @@ Now let's look at changes in recipes-core. The file task-core-tools.bbappend in recipes-core/tasks appends the similarly named recipe - located in the local Yocto Project Files at + located in the source directory at meta/recipes-core/tasks. The append file in our layer right now is Crown Bay-specific and supports EMGD and non-EMGD. @@ -395,7 +395,7 @@ Recall that the BSP uses the linux-yocto kernel as determined earlier in the mymachine.conf. The recipe for that kernel is not located in the - BSP layer but rather in the local Yocto Project files at + BSP layer but rather in the source directory at meta/recipes-kernel/linux and is named linux-yocto_3.2.bb. The SRCREV_machine and SRCREV_meta @@ -576,15 +576,14 @@ Get the environment ready for the build by sourcing the environment script. - The environment script is in the top-level of the local Yocto Project files - directory structure. + The environment script is in the top-level of the source directory. The script has the string init-build-env in the file’s name. For this example, the following command gets the build environment ready: $ source oe-init-build-env yocto-build - When you source the script a build directory is created in the current + When you source the script, a build directory is created in the current working directory. In our example we were in the poky directory. Thus, entering the previous command created the yocto-build directory. -- cgit v1.2.3-54-g00ecf