summaryrefslogtreecommitdiffstats
path: root/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-04-24 14:25:46 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-24 17:16:27 +0100
commit21cf955f9222ca61804d9f8b37071354af56d0eb (patch)
tree1a33b236965db8056dff3c6ba181145430bf86b6 /documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
parent6b0b959f1ea6b9a5c1b70e4edc2b1c626335e67b (diff)
downloadpoky-21cf955f9222ca61804d9f8b37071354af56d0eb.tar.gz
brief-yoctoprojectqs: Added reviewer feedback
Softened the opening paragraph so it was not introducing any special terms right off the bat. Renamed the section on the hardware layer to configuring the build for specific hardware. Put in a link to "build host" and used that term throughout. (From yocto-docs rev: a324cb2f9c499dc8d68d1d87265930c308cbebb7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml55
1 files changed, 29 insertions, 26 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
index 1241662df6..75dcd34128 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
@@ -33,8 +33,8 @@
33 Welcome! 33 Welcome!
34 This short document steps you through the process for a typical 34 This short document steps you through the process for a typical
35 image build using the Yocto Project. 35 image build using the Yocto Project.
36 The document also introduces how to add a machine layer and a 36 The document also introduces how to configure a build for specific
37 general layer to your Yocto Project development environment. 37 hardware.
38 You will use Yocto Project to build a reference embedded OS 38 You will use Yocto Project to build a reference embedded OS
39 called Poky. 39 called Poky.
40 <note> 40 <note>
@@ -62,7 +62,9 @@
62 <title>Compatible Linux Distribution</title> 62 <title>Compatible Linux Distribution</title>
63 63
64 <para> 64 <para>
65 Make sure your build system meets the following requirements: 65 Make sure your
66 <ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>build host</ulink>
67 meets the following requirements:
66 <itemizedlist> 68 <itemizedlist>
67 <listitem><para> 69 <listitem><para>
68 50 Gbytes of free disk space 70 50 Gbytes of free disk space
@@ -98,11 +100,11 @@
98 </section> 100 </section>
99 101
100 <section id='brief-build-system-packages'> 102 <section id='brief-build-system-packages'>
101 <title>Build System Packages</title> 103 <title>Build Host Packages</title>
102 104
103 <para> 105 <para>
104 You must install essential host packages on your 106 You must install essential host packages on your
105 development host. 107 build host.
106 The following command installs the host packages based on an 108 The following command installs the host packages based on an
107 Ubuntu distribution: 109 Ubuntu distribution:
108 <note> 110 <note>
@@ -123,7 +125,7 @@
123 <para> 125 <para>
124 Once you complete the setup instructions for your machine, 126 Once you complete the setup instructions for your machine,
125 you need to get a copy of the Poky repository on your build 127 you need to get a copy of the Poky repository on your build
126 system. 128 host.
127 Use the following commands to clone the Poky 129 Use the following commands to clone the Poky
128 repository and then checkout the &DISTRO_REL_TAG; release: 130 repository and then checkout the &DISTRO_REL_TAG; release:
129 <literallayout class='monospaced'> 131 <literallayout class='monospaced'>
@@ -274,27 +276,26 @@
274 </para> 276 </para>
275 </section> 277 </section>
276 278
277 <section id='adding-a-hardware-layer'> 279 <section id='customizing-your-build-for-specific-hardware'>
278 <title>Adding a Hardware Layer</title> 280 <title>Customizing Your Build for Specific Hardware</title>
279 281
280 <para> 282 <para>
281 So far, all you have done is quickly built an image suitable 283 So far, all you have done is quickly built an image suitable
282 for emulation only. 284 for emulation only.
283 This section shows you how you can add a hardware layer into 285 This section shows you how to customize your build for specific
284 the Yocto Project development environment. 286 hardware by adding a hardware layer into the Yocto Project
287 development environment.
285 </para> 288 </para>
286 289
287 <para> 290 <para>
288 A hardware layer provides the metadata to support specific 291 In general, layers are repositories that contain related sets of
289 hardware. 292 instructions and configurations that tell the OpenEmbedded build
290 In general, layers are repositories that contain related sets 293 system what to do.
291 of instructions and configurations that tell the OpenEmbedded 294 Isolating related metadata into functionally specific layers
292 build system what to do. 295 facilitates modular development and makes it easier to reuse the
293 Isolating related metadata into layers facilitates modular 296 layer metadata.
294 development.
295 <note> 297 <note>
296 By convention, hardware layers (i.e. Board Support Packages) 298 By convention, layer names start with the string "meta-".
297 start with the string "meta-".
298 </note> 299 </note>
299 </para> 300 </para>
300 301
@@ -327,7 +328,8 @@
327 Resolving deltas: 100% (13385/13385), done. 328 Resolving deltas: 100% (13385/13385), done.
328 Checking connectivity... done. 329 Checking connectivity... done.
329 </literallayout> 330 </literallayout>
330 The hardware layer now exists inside as 331 The hardware layer now exists with other layers inside
332 the Poky reference repository on your build host as
331 <filename>meta-altera</filename> and contains all the 333 <filename>meta-altera</filename> and contains all the
332 metadata needed to support hardware from Altera, which 334 metadata needed to support hardware from Altera, which
333 is owned by Intel. 335 is owned by Intel.
@@ -340,7 +342,8 @@
340 specifies the machine for the build. 342 specifies the machine for the build.
341 For this example, set the <filename>MACHINE</filename> 343 For this example, set the <filename>MACHINE</filename>
342 variable to "cyclone5". 344 variable to "cyclone5".
343 The build system will use the machine configurations here: 345 The OpenEmbedded build system uses the machine
346 configurations here:
344 <ulink url='https://github.com/kraj/meta-altera/blob/master/conf/machine/cyclone5.conf'></ulink>. 347 <ulink url='https://github.com/kraj/meta-altera/blob/master/conf/machine/cyclone5.conf'></ulink>.
345 <note> 348 <note>
346 See the 349 See the
@@ -358,7 +361,7 @@
358 <filename>conf</filename> directory.</para> 361 <filename>conf</filename> directory.</para>
359 362
360 <para>Use the <filename>bitbake-layers add-layer</filename> 363 <para>Use the <filename>bitbake-layers add-layer</filename>
361 command: 364 command to add the layer to the configuration file:
362 <literallayout class='monospaced'> 365 <literallayout class='monospaced'>
363 $ cd ~/poky/build 366 $ cd ~/poky/build
364 $ bitbake-layers add-layer ../meta-altera 367 $ bitbake-layers add-layer ../meta-altera
@@ -374,7 +377,7 @@
374 Completing these steps has added the 377 Completing these steps has added the
375 <filename>meta-altera</filename> layer to your Yocto Project 378 <filename>meta-altera</filename> layer to your Yocto Project
376 development environment and configured it to build for the 379 development environment and configured it to build for the
377 "imx6sxsabresd" machine. 380 "cyclone5" machine.
378 <note> 381 <note>
379 The previous steps are for demonstration purposes only. 382 The previous steps are for demonstration purposes only.
380 If you were to attempt to build an image for the 383 If you were to attempt to build an image for the
@@ -384,13 +387,13 @@
384 </para> 387 </para>
385 </section> 388 </section>
386 389
387 <section id='adding-your-own-layer'> 390 <section id='creating-your-own-general-layer'>
388 <title>Adding Your Own Layer</title> 391 <title>Creating Your Own General Layer</title>
389 392
390 <para> 393 <para>
391 Maybe you have an application or specific set of behaviors you 394 Maybe you have an application or specific set of behaviors you
392 need to isolate. 395 need to isolate.
393 You can create your own layer using the 396 You can create your own general layer using the
394 <filename>bitbake-layers create-layer</filename> command. 397 <filename>bitbake-layers create-layer</filename> command.
395 The tool automates layer creation by setting up a 398 The tool automates layer creation by setting up a
396 subdirectory with a <filename>layer.conf</filename> 399 subdirectory with a <filename>layer.conf</filename>