summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-03-20 11:25:07 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-03-25 09:41:12 +0100
commit4fda1ea35352d7d8acd76eb7d11dddb736966fec (patch)
tree3fb774bf7dfc975a98d3be071908118107baaff6 /documentation
parentc0c1befbe9b33b14c084f64b72e4a17044c0ba54 (diff)
downloadpoky-4fda1ea35352d7d8acd76eb7d11dddb736966fec.tar.gz
dev-manual: Updates to the section on creating a layer
Provided some key links to help clarify content. (From yocto-docs rev: 8d27b9946dad89729d30497bcc4de26b9a5c87d9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml26
1 files changed, 15 insertions, 11 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index e513c67e04..6bb4275267 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -37,7 +37,7 @@
37 The Yocto Project ships with tools that speed up creating 37 The Yocto Project ships with tools that speed up creating
38 layers. 38 layers.
39 This section describes the steps you perform by hand to create 39 This section describes the steps you perform by hand to create
40 a layer so that you can better understand them. 40 layers so that you can better understand them.
41 For information about the layer-creation tools, see the 41 For information about the layer-creation tools, see the
42 "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-bitbake-layers-script'>Creating a New BSP Layer Using the <filename>bitbake-layers</filename> Script</ulink>" 42 "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-bitbake-layers-script'>Creating a New BSP Layer Using the <filename>bitbake-layers</filename> Script</ulink>"
43 section in the Yocto Project Board Support Package (BSP) 43 section in the Yocto Project Board Support Package (BSP)
@@ -95,7 +95,7 @@
95 <para>The 95 <para>The
96 <filename>meta-yocto-bsp/conf/layer.conf</filename> file 96 <filename>meta-yocto-bsp/conf/layer.conf</filename> file
97 in the Yocto Project 97 in the Yocto Project
98 <ulink url='&YOCTO_GIT_URL;'>Source Repositories</ulink> 98 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf'>Source Repositories</ulink>
99 demonstrates the required syntax. 99 demonstrates the required syntax.
100 For your layer, you need to replace "yoctobsp" with the 100 For your layer, you need to replace "yoctobsp" with the
101 root name of your layer: 101 root name of your layer:
@@ -121,16 +121,17 @@
121 appended to 121 appended to
122 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBPATH'><filename>BBPATH</filename></ulink>. 122 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBPATH'><filename>BBPATH</filename></ulink>.
123 <note> 123 <note>
124 All non-distro layers, which include all BSP 124 All non-distro layers are expected to
125 layers, are expected to append the layer 125 append the layer directory to
126 directory to <filename>BBPATH</filename>. 126 <filename>BBPATH</filename>.
127 On the other hand, distro layers, such as 127 On the other hand, distro layers, such as
128 <filename>meta-poky</filename>, can choose 128 <filename>meta-poky</filename>, can choose
129 to enforce their own precedence over 129 to enforce their own precedence over
130 <filename>BBPATH</filename>. 130 <filename>BBPATH</filename>.
131 For an example of that syntax, see the 131 For an example of that syntax, see the
132 <filename>meta-poky/conf/layer.conf</filename> 132 <filename>meta-poky/conf/layer.conf</filename>
133 file for in the Source Repositories. 133 file for in the
134 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf'>Source Repositories</ulink>.
134 </note> 135 </note>
135 </para></listitem> 136 </para></listitem>
136 <listitem><para> 137 <listitem><para>
@@ -140,7 +141,7 @@
140 <listitem><para> 141 <listitem><para>
141 The 142 The
142 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename> 143 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename>
143 variable is then appended with the layer name, 144 variable is appended with the layer name,
144 which is "yoctobsp" in this example. 145 which is "yoctobsp" in this example.
145 </para></listitem> 146 </para></listitem>
146 <listitem><para> 147 <listitem><para>
@@ -159,7 +160,7 @@
159 <listitem><para> 160 <listitem><para>
160 The 161 The
161 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename> 162 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename>
162 variable then assigns a priority to the layer. 163 variable assigns a priority to the layer.
163 Applying priorities is useful in situations 164 Applying priorities is useful in situations
164 where the same recipe might appear in multiple 165 where the same recipe might appear in multiple
165 layers. 166 layers.
@@ -206,9 +207,12 @@
206 you need in <filename>recipes-*</filename> 207 you need in <filename>recipes-*</filename>
207 subdirectories within the layer. 208 subdirectories within the layer.
208 <note> 209 <note>
209 In order to be compliant with the Yocto Project, 210 For an explanation of layer hierarchy that
210 a layer must contain a 211 is compliant with the Yocto Project, see
211 <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-readme'>README file.</ulink> 212 the
213 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout'>Example Filesystem Layout</ulink>"
214 section in the Yocto Project Board
215 Support Package (BSP) Developer's Guide.
212 </note> 216 </note>
213 </para></listitem> 217 </para></listitem>
214 <listitem><para> 218 <listitem><para>