summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-03-20 16:15:16 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-03-25 09:41:13 +0100
commitfcbe72179c01fdb93a58a2016eef5e89ab0c63ba (patch)
treeaebff259c223d657a0ef8a71dd7f8a50d946d975 /documentation/dev-manual
parent955e49c134e6093be47bb7035a0222bd00651135 (diff)
downloadpoky-fcbe72179c01fdb93a58a2016eef5e89ab0c63ba.tar.gz
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 <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml57
1 files changed, 47 insertions, 10 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 @@
966 The <filename>bitbake-layers</filename> script with the 966 The <filename>bitbake-layers</filename> script with the
967 <filename>create-layer</filename> subcommand simplifies 967 <filename>create-layer</filename> subcommand simplifies
968 creating a new general layer. 968 creating a new general layer.
969 <note> 969 <note><title>Notes</title>
970 For information on BSP layers, see the 970 <itemizedlist>
971 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" 971 <listitem><para>
972 section in the Yocto Project Board Specific (BSP) 972 For information on BSP layers, see the
973 Developer's Guide. 973 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
974 section in the Yocto Project Board Specific (BSP)
975 Developer's Guide.
976 </para></listitem>
977 <listitem><para>
978 In order to use a layer with the OpenEmbedded
979 build system, you need to add the layer to your
980 <filename>bblayers.conf</filename> configuration
981 file.
982 See the
983 "<link linkend='adding-a-layer-using-the-bitbake-layers-script'>Adding a Layer Using the <filename>bitbake-layers</filename> Script</link>"
984 section for more information.
985 </para></listitem>
986 </itemizedlist>
974 </note> 987 </note>
975 The default mode of the script's operation with this 988 The default mode of the script's operation with this
976 subcommand is to create a layer with the following: 989 subcommand is to create a layer with the following:
@@ -1009,6 +1022,13 @@
1009 <literallayout class='monospaced'> 1022 <literallayout class='monospaced'>
1010 $ bitbake-layers create-layer <replaceable>your_layer_name</replaceable> 1023 $ bitbake-layers create-layer <replaceable>your_layer_name</replaceable>
1011 </literallayout> 1024 </literallayout>
1025 As an example, the following command adds a layer named
1026 <filename>meta-scottrif</filename>:
1027 <literallayout class='monospaced'>
1028 $ bitbake-layers create-layer meta-scottrif
1029 NOTE: Starting bitbake server...
1030 Add your new layer with 'bitbake-layers add-layer meta-scottrif'
1031 </literallayout>
1012 </para> 1032 </para>
1013 1033
1014 <para> 1034 <para>
@@ -1051,19 +1071,31 @@
1051 Filename of the example recipe 1071 Filename of the example recipe
1052 </literallayout> 1072 </literallayout>
1053 </para> 1073 </para>
1074 </section>
1075
1076 <section id='adding-a-layer-using-the-bitbake-layers-script'>
1077 <title>Adding a Layer Using the <filename>bitbake-layers</filename> Script</title>
1054 1078
1055 <para> 1079 <para>
1056 Once you create your general layer, you must add it to your 1080 Once you create your general layer, you must add it to your
1057 <filename>bblayers.conf</filename> file. 1081 <filename>bblayers.conf</filename> file.
1058 You can add your layer by using the 1082 Adding the layer to this configuration file makes the
1083 OpenEmbedded build system aware of your layer so that it can
1084 search it for metadata.
1085 </para>
1086
1087 <para>
1088 Add your layer by using the
1059 <filename>bitbake-layers add-layer</filename> command: 1089 <filename>bitbake-layers add-layer</filename> command:
1060 <literallayout class='monospaced'> 1090 <literallayout class='monospaced'>
1061 $ bitbake-layers add-layer <replaceable>your_layer_name</replaceable> 1091 $ bitbake-layers add-layer <replaceable>your_layer_name</replaceable>
1062 </literallayout> 1092 </literallayout>
1063 Here is an example where a layer named 1093 Here is an example that adds a layer named
1064 <filename>meta-scottrif</filename> is added and then the 1094 <filename>meta-scottrif</filename> to the configuration file.
1065 layers are shown using the 1095 Following the command that adds the layer is another
1066 <filename>bitbake-layers show-layers</filename> command: 1096 <filename>bitbake-layers</filename> command that shows the
1097 layers that are in your <filename>bblayers.conf</filename>
1098 file:
1067 <literallayout class='monospaced'> 1099 <literallayout class='monospaced'>
1068 $ bitbake-layers add-layer meta-scottrif 1100 $ bitbake-layers add-layer meta-scottrif
1069 NOTE: Starting bitbake server... 1101 NOTE: Starting bitbake server...
@@ -1081,6 +1113,11 @@
1081 </literallayout> 1113 </literallayout>
1082 Adding the layer to this file enables the build system to 1114 Adding the layer to this file enables the build system to
1083 locate the layer during the build. 1115 locate the layer during the build.
1116 <note>
1117 During a build, the OpenEmbedded build system looks in
1118 the layers from the top of the list down to the bottom
1119 in that order.
1120 </note>
1084 </para> 1121 </para>
1085 </section> 1122 </section>
1086 </section> 1123 </section>