From fcbe72179c01fdb93a58a2016eef5e89ab0c63ba Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 20 Mar 2018 16:15:16 -0700 Subject: documentation: Updated the section on creating a general script Split this section into two sections: one for creating the layer using bitbake-layers create-layer and one for adding the layer to bblayers.conf using bitbake-layers add-layer. Needed to update some references in the yocto-project-qs and kernel-dev manuals. (From yocto-docs rev: 741a29b0cbeaaeaa0ac9155036ace2623938aee3) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 57 ++++++++++++++++++---- documentation/kernel-dev/kernel-dev-common.xml | 7 +-- documentation/yocto-project-qs/qs.xml | 4 +- 3 files changed, 53 insertions(+), 15 deletions(-) diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 20f97b9f86..11b53ac116 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -966,11 +966,24 @@ The bitbake-layers script with the create-layer subcommand simplifies creating a new general layer. - - For information on BSP layers, see the - "BSP Layers" - section in the Yocto Project Board Specific (BSP) - Developer's Guide. + Notes + + + For information on BSP layers, see the + "BSP Layers" + section in the Yocto Project Board Specific (BSP) + Developer's Guide. + + + In order to use a layer with the OpenEmbedded + build system, you need to add the layer to your + bblayers.conf configuration + file. + See the + "Adding a Layer Using the bitbake-layers Script" + section for more information. + + The default mode of the script's operation with this subcommand is to create a layer with the following: @@ -1009,6 +1022,13 @@ $ bitbake-layers create-layer your_layer_name + As an example, the following command adds a layer named + meta-scottrif: + + $ bitbake-layers create-layer meta-scottrif + NOTE: Starting bitbake server... + Add your new layer with 'bitbake-layers add-layer meta-scottrif' + @@ -1051,19 +1071,31 @@ Filename of the example recipe + + +
+ Adding a Layer Using the <filename>bitbake-layers</filename> Script Once you create your general layer, you must add it to your bblayers.conf file. - You can add your layer by using the + Adding the layer to this configuration file makes the + OpenEmbedded build system aware of your layer so that it can + search it for metadata. + + + + Add your layer by using the bitbake-layers add-layer command: $ bitbake-layers add-layer your_layer_name - Here is an example where a layer named - meta-scottrif is added and then the - layers are shown using the - bitbake-layers show-layers command: + Here is an example that adds a layer named + meta-scottrif to the configuration file. + Following the command that adds the layer is another + bitbake-layers command that shows the + layers that are in your bblayers.conf + file: $ bitbake-layers add-layer meta-scottrif NOTE: Starting bitbake server... @@ -1081,6 +1113,11 @@ Adding the layer to this file enables the build system to locate the layer during the build. + + During a build, the OpenEmbedded build system looks in + the layers from the top of the list down to the bottom + in that order. +
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index 1ea5ca53d2..9686609bf5 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml @@ -136,7 +136,7 @@ Developer's Guide, respectively. For information on how to use the bitbake-layers create-layer - command, see the + command to quickly set up a layer, see the "Creating a General Layer Using the bitbake-layers Script" section in the Yocto Project Development Tasks Manual. @@ -360,7 +360,7 @@ Developer's Guide, respectively. For information on how to use the bitbake-layers create-layer - command, see the + command to quickly set up a layer, see the "Creating a General Layer Using the bitbake-layers Script" section in the Yocto Project Development Tasks Manual. @@ -489,7 +489,8 @@ See the "Creating a General Layer Using the bitbake-layers Script" section in the Yocto Project Development Tasks Manual for - information on how to use this script. + information on how to use this script to quick set up a + new layer. diff --git a/documentation/yocto-project-qs/qs.xml b/documentation/yocto-project-qs/qs.xml index 23553f3516..2e5defe6a0 100644 --- a/documentation/yocto-project-qs/qs.xml +++ b/documentation/yocto-project-qs/qs.xml @@ -971,8 +971,8 @@ section in the same manual. - Add a Layer for Software: - For steps on how to add a general layer for software, + Create a Layer for Software: + For steps on how to create a general layer for software, see the "Creating a General Layer Using the bitbake-layers Script" section in the Yocto Project Development Tasks Manual. -- cgit v1.2.3-54-g00ecf