summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-08-18 12:48:44 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-09-02 00:52:48 +0100
commit2b93720cfcd7832d38ccf557cc54fc7565db1f24 (patch)
treedb5069a5e2c6aa9409e61b0bffbc45b5a6e3d874
parenta99c2c5581f8847fa3d95696f0f985ea87f9da9d (diff)
downloadpoky-2b93720cfcd7832d38ccf557cc54fc7565db1f24.tar.gz
bsp-guide, dev-manual: Moved BSP Layer prep steps to bsp-guide
The YP Development Manual had some build host preparation steps as part of the chapter that talks about getting a host ready for using YP. These steps are better suited in the BSP Guide. I moved them there and filled out the steps to be more complete. (From yocto-docs rev: 2277812d0dd411a103a4a4252d4cb90c471901c9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/bsp-guide/bsp.xml153
-rw-r--r--documentation/dev-manual/dev-manual-start.xml109
2 files changed, 151 insertions, 111 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index c6591cc284..6450c9d0aa 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -145,6 +145,155 @@
145 </para> 145 </para>
146 </section> 146 </section>
147 147
148 <section id='preparing-your-build-host-to-work-with-bsp-layers'>
149 <title>Preparing Your Build Host to Work With BSP Layers</title>
150
151 <para>
152 This section describes how to get your build host ready
153 to work with BSP layers.
154 Once you have the host set up, you can create the layer
155 as described in the
156 "<link linkend='creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a new BSP Layer Using the yocto-bsp Script</link>"
157 section.
158 <note>
159 For structural information on BSPs, see the
160 <link linkend='bsp-filelayout'>Example Filesystem Layout</link>
161 section.
162 </note>
163 <orderedlist>
164 <listitem><para>
165 <emphasis>Set Up the Build Environment:</emphasis>
166 Be sure you are set up to use BitBake in a shell.
167 See the
168 "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up the Development Host to Use the Yocto Project</ulink>"
169 section in the Yocto Project Development Manual for information
170 on how to get a build host ready that is either a native
171 Linux machine or a machine that uses CROPS.
172 </para></listitem>
173 <listitem><para>
174 <emphasis>Clone the <filename>poky</filename> Repository:</emphasis>
175 You need to have a local copy of the Yocto Project
176 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
177 (i.e. a local <filename>poky</filename> repository).
178 See the
179 "<ulink url='&YOCTO_DOCS_DEV_URL;#cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</ulink>"
180 and possibly the
181 "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking Out by Branch in Poky</ulink>"
182 and
183 "<ulink url='&YOCTO_DOCS_DEV_URL;#checkout-out-by-tag-in-poky'>Checking Out by Tag in Poky</ulink>"
184 sections all in the Yocto Project Development Manual for
185 information on how to clone the <filename>poky</filename>
186 repository and check out the appropriate branch for your work.
187 </para></listitem>
188 <listitem><para>
189 <emphasis>Determine the BSP Layer You Want:</emphasis>
190 The Yocto Project supports many BSPs, which are maintained in
191 their own layers or in layers designed to contain several
192 BSPs.
193 To get an idea of machine support through BSP layers, you can
194 look at the
195 <ulink url='&YOCTO_RELEASE_DL_URL;/machines'>index of machines</ulink>
196 for the release.
197 </para></listitem>
198 <listitem><para>
199 <emphasis>Optionally Clone the
200 <filename>meta-intel</filename> BSP Layer:</emphasis>
201 If your hardware is based on current Intel CPUs and devices,
202 you can leverage this BSP layer.
203 For details on the <filename>meta-intel</filename> BSP layer,
204 see the layer's
205 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/meta-intel/tree/README'><filename>README</filename></ulink>
206 file.
207 <orderedlist>
208 <listitem><para>
209 <emphasis>Navigate to Your Source Directory:</emphasis>
210 Typically, you set up the
211 <filename>meta-intel</filename> Git repository
212 inside the
213 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
214 (e.g. <filename>poky</filename>).
215 </para></listitem>
216 <listitem><para>
217 <emphasis>Clone the Layer:</emphasis>
218 <literallayout class='monospaced'>
219 $ git clone git://git.yoctoproject.org/meta-intel.git
220 Cloning into 'meta-intel'...
221 remote: Counting objects: 14224, done.
222 remote: Compressing objects: 100% (4591/4591), done.
223 remote: Total 14224 (delta 8245), reused 13985 (delta 8006)
224 Receiving objects: 100% (14224/14224), 4.29 MiB | 2.90 MiB/s, done.
225 Resolving deltas: 100% (8245/8245), done.
226 Checking connectivity... done.
227 </literallayout>
228 </para></listitem>
229 <listitem><para>
230 <emphasis>Check Out the Proper Branch:</emphasis>
231 The branch you check out for
232 <filename>meta-intel</filename> must match the same
233 branch you are using for the Yocto Project release
234 (e.g. &DISTRO_NAME_NO_CAP;):
235 <literallayout class='monospaced'>
236 $ git checkout <replaceable>branch_name</replaceable>
237 </literallayout>
238 For an example on how to discover branch names and
239 checkout on a branch, see the
240 "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking Out By Branch in Poky</ulink>"
241 section.
242 </para></listitem>
243 </orderedlist>
244 </para></listitem>
245 <listitem><para>
246 <emphasis>Optionally Set Up an Alternative BSP Layer:</emphasis>
247 If your hardware can be more closely leveraged to an
248 existing BSP not within the <filename>meta-intel</filename>
249 BSP layer, you can clone that BSP layer.</para>
250
251 <para>The process is identical to the process used for the
252 <filename>meta-intel</filename> layer except for the layer's
253 name.
254 For example, if you determine that your hardware most
255 closely matches the <filename>meta-minnow</filename>,
256 clone that layer:
257 <literallayout class='monospaced'>
258 $ git clone git://git.yoctoproject.org/meta-minnow
259 Cloning into 'meta-minnow'...
260 remote: Counting objects: 456, done.
261 remote: Compressing objects: 100% (283/283), done.
262 remote: Total 456 (delta 163), reused 384 (delta 91)
263 Receiving objects: 100% (456/456), 96.74 KiB | 0 bytes/s, done.
264 Resolving deltas: 100% (163/163), done.
265 Checking connectivity... done.
266 </literallayout>
267 </para></listitem>
268 <listitem><para>
269 <emphasis>Initialize the Build Environment:</emphasis>
270 While in the root directory of the Source Directory (i.e.
271 <filename>poky</filename>), run the
272 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
273 environment setup script to define the OpenEmbedded
274 build environment on your build host.
275 <literallayout class='monospaced'>
276 $ source &OE_INIT_FILE;
277 </literallayout>
278 Among other things, the script creates the
279 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
280 which is <filename>build</filename> in this case
281 and is located in the
282 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
283 After the script runs, your current working directory
284 is set to the <filename>build</filename> directory.
285 <note>
286 For information on running a memory-resident
287 <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>,
288 see the
289 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
290 setup script.
291 </note>
292 </para></listitem>
293 </orderedlist>
294 </para>
295 </section>
296
148 <section id="bsp-filelayout"> 297 <section id="bsp-filelayout">
149 <title>Example Filesystem Layout</title> 298 <title>Example Filesystem Layout</title>
150 299
@@ -756,8 +905,8 @@
756 your system gives you access to layers you might be able 905 your system gives you access to layers you might be able
757 to build on or modify to create your BSP. 906 to build on or modify to create your BSP.
758 For information on how to get these files, see the 907 For information on how to get these files, see the
759 "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-bsp-layers'>Setting Up BSP Layers</ulink>" 908 "<link linkend='preparing-your-build-host-to-work-with-bsp-layers'>Preparing Your Build Host to Work with BSP Layers</link>"
760 section in the Yocto Project Development Manual. 909 section.
761 </para></listitem> 910 </para></listitem>
762 <listitem><para> 911 <listitem><para>
763 <emphasis>Create Your Own BSP Layer Using the 912 <emphasis>Create Your Own BSP Layer Using the
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 01a18942fc..e840385c25 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -203,115 +203,6 @@
203 </para> 203 </para>
204 </section> 204 </section>
205 205
206 <section id='setting-up-bsp-layers'>
207 <title>Setting Up BSP Layers</title>
208
209 <para>
210 This section describes how to set up a layer for a Board Support
211 Package (BSP).
212 For structural information on BSPs, see the
213 <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-guide'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
214 <orderedlist>
215 <listitem><para>
216 <emphasis>Determine the BSP Layer You Want:</emphasis>
217 The Yocto Project supports many BSPs, which are maintained in
218 their own layers or in layers designed to contain several
219 BSPs.
220 To get an idea of machine support through BSP layers, you can
221 look at the
222 <ulink url='&YOCTO_RELEASE_DL_URL;/machines'>index of machines</ulink>
223 for the release.
224 <note>
225 The Yocto Project uses the following BSP layer naming
226 scheme:
227 <literallayout class='monospaced'>
228 meta-<replaceable>bsp_name</replaceable>
229 </literallayout>
230 where <replaceable>bsp_name</replaceable> is the recognized
231 BSP name.
232 Here is an example:
233 <literallayout class='monospaced'>
234 meta-raspberrypi
235 </literallayout>
236 See the
237 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
238 section in the Yocto Project Board Support Package (BSP)
239 Developer's Guide for more information on BSP Layers.
240 </note>
241 </para></listitem>
242 <listitem><para>
243 <emphasis>Optionally Set Up the <filename>meta-intel</filename> BSP Layer:</emphasis>
244 If your hardware is based on current Intel CPUs and devices,
245 you can leverage this BSP layer.
246 For details on the <filename>meta-intel</filename> BSP layer,
247 see the layer's
248 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/meta-intel/tree/README'><filename>README</filename></ulink>
249 file.
250 <orderedlist>
251 <listitem><para>
252 <emphasis>Navigate to Your Source Directory:</emphasis>
253 Typically, you set up the
254 <filename>meta-intel</filename> Git repository
255 inside the
256 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
257 (e.g. <filename>poky</filename>).
258 </para></listitem>
259 <listitem><para>
260 <emphasis>Clone the Layer:</emphasis>
261 <literallayout class='monospaced'>
262 $ git clone git://git.yoctoproject.org/meta-intel.git
263 Cloning into 'meta-intel'...
264 remote: Counting objects: 14224, done.
265 remote: Compressing objects: 100% (4591/4591), done.
266 remote: Total 14224 (delta 8245), reused 13985 (delta 8006)
267 Receiving objects: 100% (14224/14224), 4.29 MiB | 2.90 MiB/s, done.
268 Resolving deltas: 100% (8245/8245), done.
269 Checking connectivity... done.
270 </literallayout>
271 </para></listitem>
272 <listitem><para>
273 <emphasis>Check Out the Proper Branch:</emphasis>
274 The branch you check out for
275 <filename>meta-intel</filename> must match the same
276 branch you are using for the Yocto Project release
277 (e.g. &DISTRO_NAME_NO_CAP;):
278 <literallayout class='monospaced'>
279 $ git checkout <replaceable>branch_name</replaceable>
280 </literallayout>
281 For an example on how to discover branch names and
282 checkout on a branch, see the
283 "<link linkend='checking-out-by-branch-in-poky'>Checking Out By Branch in Poky</link>"
284 section.
285 </para></listitem>
286 </orderedlist>
287 </para></listitem>
288 <listitem><para>
289 <emphasis>Optionally Set Up an Alternative BSP Layer:</emphasis>
290 If your hardware can be more closely leveraged to an
291 existing BSP not within the <filename>meta-intel</filename>
292 BSP layer, you can clone that BSP layer.</para>
293
294 <para>The process is identical to the process used for the
295 <filename>meta-intel</filename> layer except for the layer's
296 name.
297 For example, if you determine that your hardware most
298 closely matches the <filename>meta-minnow</filename>,
299 clone that layer:
300 <literallayout class='monospaced'>
301 $ git clone git://git.yoctoproject.org/meta-minnow
302 Cloning into 'meta-minnow'...
303 remote: Counting objects: 456, done.
304 remote: Compressing objects: 100% (283/283), done.
305 remote: Total 456 (delta 163), reused 384 (delta 91)
306 Receiving objects: 100% (456/456), 96.74 KiB | 0 bytes/s, done.
307 Resolving deltas: 100% (163/163), done.
308 Checking connectivity... done.
309 </literallayout>
310 </para></listitem>
311 </orderedlist>
312 </para>
313 </section>
314
315 <section id='local-kernel-files'> 206 <section id='local-kernel-files'>
316 <title>Setting Up to Work on a Kernel</title> 207 <title>Setting Up to Work on a Kernel</title>
317 208