diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index fd143ede14..482f2ebe7f 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -37,7 +37,7 @@ Although not a strict requirement, layers in the Yocto Project use the following well established naming convention: - meta-<bsp_name> + meta-bsp_name The string "meta-" is prepended to the machine or platform name, which is "bsp_name" in the above form. @@ -50,7 +50,7 @@ Yocto Project Source Repositories through a web interface at . - If you go to that interface you will find near the bottom of the list + If you go to that interface, you will find near the bottom of the list under "Yocto Metadata Layers" several BSP layers all of which are supported by the Yocto Project (e.g. meta-minnow, meta-raspberrypi, and @@ -72,7 +72,7 @@ - The layer's base directory (meta-<bsp_name>) is the root + The layer's base directory (meta-bsp_name) is the root of the BSP Layer. This root is what you add to the BBLAYERS @@ -175,17 +175,17 @@ for specific BSPs could differ. - meta-<bsp_name>/ - meta-<bsp_name>/<bsp_license_file> - meta-<bsp_name>/README - meta-<bsp_name>/README.sources - meta-<bsp_name>/binary/<bootable_images> - meta-<bsp_name>/conf/layer.conf - meta-<bsp_name>/conf/machine/*.conf - meta-<bsp_name>/recipes-bsp/* - meta-<bsp_name>/recipes-core/* - meta-<bsp_name>/recipes-graphics/* - meta-<bsp_name>/recipes-kernel/linux/linux-yocto_<kernel_rev>.bbappend + meta-bsp_name/ + meta-bsp_name/bsp_license_file + meta-bsp_name/README + meta-bsp_name/README.sources + meta-bsp_name/binary/bootable_images + meta-bsp_name/conf/layer.conf + meta-bsp_name/conf/machine/*.conf + meta-bsp_name/recipes-bsp/* + meta-bsp_name/recipes-core/* + meta-bsp_name/recipes-graphics/* + meta-bsp_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend @@ -221,7 +221,6 @@ meta-crownbay/recipes-kernel/linux/linux-yocto-dev.bbappend meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.10.bbappend meta-crownbay/recipes-kernel/linux/linux-yocto_3.10.bbappend - meta-crownbay/recipes-kernel/linux/linux-yocto_3.14.bbappend @@ -235,7 +234,7 @@ You can find these files in the BSP Layer at: - meta-<bsp_name>/<bsp_license_file> + meta-bsp_name/bsp_license_file @@ -257,7 +256,7 @@ You can find this file in the BSP Layer at: - meta-<bsp_name>/README + meta-bsp_name/README @@ -281,7 +280,7 @@ You can find this file in the BSP Layer at: - meta-<bsp_name>/README.sources + meta-bsp_name/README.sources @@ -300,7 +299,7 @@ You can find these files in the BSP Layer at: - meta-<bsp_name>/binary/<bootable_images> + meta-bsp_name/binary/bootable_images @@ -316,7 +315,7 @@ The exact types of binaries present are highly hardware-dependent. - However, a README file should be present in the BSP Layer that explains how to use + However, a README file should be present in the BSP Layer that explains how to use the kernels and images with the target hardware. If pre-built binaries are present, source code to meet licensing requirements must also exist in some form. @@ -328,7 +327,7 @@ You can find this file in the BSP Layer at: - meta-<bsp_name>/conf/layer.conf + meta-bsp_name/conf/layer.conf @@ -338,9 +337,9 @@ contents of the layer, and contains information about how the build system should use it. Generally, a standard boilerplate file such as the following works. - In the following example, you would replace "bsp" and - "_bsp" with the actual name - of the BSP (i.e. <bsp_name> from the example template). + In the following example, you would replace "bsp" and + "_bsp" with the actual name + of the BSP (i.e. bsp_name from the example template). @@ -381,7 +380,7 @@ You can find these files in the BSP Layer at: - meta-<bsp_name>/conf/machine/*.conf + meta-bsp_name/conf/machine/*.conf @@ -441,7 +440,7 @@ You can find these files in the BSP Layer at: - meta-<bsp_name>/recipes-bsp/* + meta-bsp_name/recipes-bsp/* @@ -478,7 +477,7 @@ You can find these files in the BSP Layer at: - meta-<bsp_name>/recipes-graphics/* + meta-bsp_name/recipes-graphics/* @@ -502,7 +501,7 @@ You can find these files in the BSP Layer at: - meta-<bsp_name>/recipes-kernel/linux/linux-yocto_*.bbappend + meta-bsp_name/recipes-kernel/linux/linux-yocto_*.bbappend @@ -515,13 +514,13 @@ at meta/recipes-kernel/linux. You can append your specific changes to the kernel recipe by using a similarly named append file, which is located in the BSP Layer (e.g. - the meta-<bsp_name>/recipes-kernel/linux directory). + the meta-bsp_name/recipes-kernel/linux directory). Suppose you are using the linux-yocto_3.10.bb recipe to build the kernel. In other words, you have selected the kernel in your - <bsp_name>.conf file by adding these types + bsp_name.conf file by adding these types of statements: PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" @@ -530,7 +529,7 @@ When the preferred provider is assumed by default, the PREFERRED_PROVIDER statement does not appear in the - <bsp_name>.conf file. + bsp_name.conf file. You would use the linux-yocto_3.10.bbappend file to append specific BSP settings to the kernel, thus configuring the kernel for your particular BSP. @@ -752,7 +751,7 @@ License File: You must include a license file in the - meta-<bsp_name> directory. + meta-bsp_name directory. This license covers the BSP Metadata as a whole. You must specify which license to use since there is no default license if one is not specified. @@ -762,7 +761,7 @@ as an example. README File: You must include a README file in the - meta-<bsp_name> directory. + meta-bsp_name directory. See the README file for the Fish River Island 2 BSP in the meta-fri2 BSP layer @@ -804,7 +803,7 @@ README.sources File: You must include a README.sources in the - meta-<bsp_name> directory. + meta-bsp_name directory. This file specifies exactly where you can find the sources used to generate the binary images contained in the binary directory, if present. @@ -814,12 +813,13 @@ as an example. Layer Configuration File: You must include a conf/layer.conf in the - meta-<bsp_name> directory. - This file identifies the meta-<bsp_name> + meta-bsp_name directory. + This file identifies the meta-bsp_name BSP layer as a layer to the build system. Machine Configuration File: - You must include one or more conf/machine/<bsp_name>.conf - files in the meta-<bsp_name> directory. + You must include one or more + conf/machine/bsp_name.conf + files in the meta-bsp_name directory. These configuration files define machine targets that can be built using the BSP layer. Multiple machine configuration files define variations of machine @@ -866,7 +866,7 @@ filesystems meant to allow users to boot the BSP for evaluation purposes, you should put the images and artifacts within a binary/ subdirectory located in the - meta-<bsp_name> directory. + meta-bsp_name directory. If you do include a bootable image as part of the BSP and the image was built by software covered by the GPL or other open source licenses, it is your responsibility to understand @@ -1100,7 +1100,7 @@ Consequently, to use the scripts, you must source the environment just as you would when invoking a build: - $ source oe-init-build-env [build_dir] + $ source oe-init-build-env build_dir