diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 57 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-common.xml | 7 | ||||
-rw-r--r-- | 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 @@ | |||
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> |
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 @@ | |||
136 | Developer's Guide, respectively. | 136 | Developer's Guide, respectively. |
137 | For information on how to use the | 137 | For information on how to use the |
138 | <filename>bitbake-layers create-layer</filename> | 138 | <filename>bitbake-layers create-layer</filename> |
139 | command, see the | 139 | command to quickly set up a layer, see the |
140 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" | 140 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" |
141 | section in the Yocto Project Development Tasks | 141 | section in the Yocto Project Development Tasks |
142 | Manual. | 142 | Manual. |
@@ -360,7 +360,7 @@ | |||
360 | Developer's Guide, respectively. | 360 | Developer's Guide, respectively. |
361 | For information on how to use the | 361 | For information on how to use the |
362 | <filename>bitbake-layers create-layer</filename> | 362 | <filename>bitbake-layers create-layer</filename> |
363 | command, see the | 363 | command to quickly set up a layer, see the |
364 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" | 364 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" |
365 | section in the Yocto Project Development Tasks | 365 | section in the Yocto Project Development Tasks |
366 | Manual. | 366 | Manual. |
@@ -489,7 +489,8 @@ | |||
489 | See the | 489 | See the |
490 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" | 490 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" |
491 | section in the Yocto Project Development Tasks Manual for | 491 | section in the Yocto Project Development Tasks Manual for |
492 | information on how to use this script. | 492 | information on how to use this script to quick set up a |
493 | new layer. | ||
493 | </note> | 494 | </note> |
494 | </para> | 495 | </para> |
495 | 496 | ||
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 @@ | |||
971 | section in the same manual. | 971 | section in the same manual. |
972 | </para></listitem> | 972 | </para></listitem> |
973 | <listitem><para> | 973 | <listitem><para> |
974 | <emphasis>Add a Layer for Software:</emphasis> | 974 | <emphasis>Create a Layer for Software:</emphasis> |
975 | For steps on how to add a general layer for software, | 975 | For steps on how to create a general layer for software, |
976 | see the | 976 | see the |
977 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" | 977 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" |
978 | section in the Yocto Project Development Tasks Manual. | 978 | section in the Yocto Project Development Tasks Manual. |