diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-04-25 11:45:44 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:17:59 +0100 |
commit | 98c0b1ea5de0454230c309ef375d1c15fee5fbfb (patch) | |
tree | f0e1aad832d0bab24d7651a11931d8e183bd361a /documentation | |
parent | edd28ad3c9150c9713d8978f587ff066077418bf (diff) | |
download | poky-98c0b1ea5de0454230c309ef375d1c15fee5fbfb.tar.gz |
overview-manual: Updates to "User Configuration" section.
This section was pretty out of date. I have updated many areas
of the text.
(From yocto-docs rev: 640cdc7fb9d4f93c86b907d631e4f90b261d5ea1)
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/overview-manual/overview-manual-concepts.xml | 84 |
1 files changed, 51 insertions, 33 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.xml b/documentation/overview-manual/overview-manual-concepts.xml index e17a973c9f..b8d1fa2b92 100644 --- a/documentation/overview-manual/overview-manual-concepts.xml +++ b/documentation/overview-manual/overview-manual-concepts.xml | |||
@@ -251,13 +251,14 @@ | |||
251 | </para> | 251 | </para> |
252 | 252 | ||
253 | <para> | 253 | <para> |
254 | The following diagram represents a build at a high level. | 254 | The following diagram represents the high-level workflow of a |
255 | build. | ||
255 | The remainder of this section expands on the fundamental input, | 256 | The remainder of this section expands on the fundamental input, |
256 | output, process, and metadata logical blocks that make up the | 257 | output, process, and metadata logical blocks that make up the |
257 | OpenEmbedded build system's workflow. | 258 | workflow. |
258 | </para> | 259 | </para> |
259 | 260 | ||
260 | <para id='general-yocto-environment-figure'> | 261 | <para id='general-workflow-figure'> |
261 | <imagedata fileref="figures/YP-flow-diagram.png" format="PNG" align='center' width="8in"/> | 262 | <imagedata fileref="figures/YP-flow-diagram.png" format="PNG" align='center' width="8in"/> |
262 | </para> | 263 | </para> |
263 | 264 | ||
@@ -323,7 +324,7 @@ | |||
323 | <para> | 324 | <para> |
324 | The following figure shows an expanded representation of the | 325 | The following figure shows an expanded representation of the |
325 | "User Configuration" box of the | 326 | "User Configuration" box of the |
326 | <link linkend='general-yocto-environment-figure'>general Build Process figure</link>: | 327 | <link linkend='general-workflow-figure'>general workflow figure</link>: |
327 | </para> | 328 | </para> |
328 | 329 | ||
329 | <para> | 330 | <para> |
@@ -335,21 +336,22 @@ | |||
335 | complete a build. | 336 | complete a build. |
336 | These files are <filename>*.conf</filename> files. | 337 | These files are <filename>*.conf</filename> files. |
337 | The minimally necessary ones reside as example files in the | 338 | The minimally necessary ones reside as example files in the |
339 | <filename>build/conf</filename> directory of the | ||
338 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. | 340 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. |
339 | For simplicity, this section refers to the Source Directory as | 341 | For simplicity, this section refers to the Source Directory as |
340 | the "Poky Directory." | 342 | the "Poky Directory." |
341 | </para> | 343 | </para> |
342 | 344 | ||
343 | <para> | 345 | <para> |
344 | When you clone the <filename>poky</filename> Git repository | 346 | When you clone the |
345 | or you download and unpack a Yocto Project release, you | 347 | <ulink url='&YOCTO_DOCS_REF_URL;#poky'>Poky</ulink> |
346 | can set up the Source Directory to be named anything you want. | 348 | Git repository or you download and unpack a Yocto Project |
349 | release, you can set up the Source Directory to be named | ||
350 | anything you want. | ||
347 | For this discussion, the cloned repository uses the default | 351 | For this discussion, the cloned repository uses the default |
348 | name <filename>poky</filename>. | 352 | name <filename>poky</filename>. |
349 | <note> | 353 | <note> |
350 | The | 354 | The Poky repository is primarily an aggregation of existing |
351 | <ulink url='&YOCTO_DOCS_REF_URL;#poky'>Poky</ulink> | ||
352 | repository is primarily an aggregation of existing | ||
353 | repositories. | 355 | repositories. |
354 | It is not a canonical upstream source. | 356 | It is not a canonical upstream source. |
355 | </note> | 357 | </note> |
@@ -360,10 +362,9 @@ | |||
360 | a <filename>conf</filename> directory that has example | 362 | a <filename>conf</filename> directory that has example |
361 | configuration files. | 363 | configuration files. |
362 | These example files are used as a basis for creating actual | 364 | These example files are used as a basis for creating actual |
363 | configuration files when you source the build environment | 365 | configuration files when you source |
364 | script | 366 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>, |
365 | (i.e. | 367 | which is the build environment script. |
366 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>). | ||
367 | </para> | 368 | </para> |
368 | 369 | ||
369 | <para> | 370 | <para> |
@@ -415,19 +416,10 @@ | |||
415 | To see the default configurations in a | 416 | To see the default configurations in a |
416 | <filename>local.conf</filename> file created by the build | 417 | <filename>local.conf</filename> file created by the build |
417 | environment script, see the | 418 | environment script, see the |
418 | <filename>local.conf.sample</filename> in the | 419 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample'><filename>local.conf.sample</filename></ulink> |
419 | <filename>meta-poky</filename> layer: | 420 | in the <filename>meta-poky</filename> layer: |
420 | <itemizedlist> | 421 | <itemizedlist> |
421 | <listitem><para> | 422 | <listitem><para> |
422 | <emphasis>Parallelism Options:</emphasis> | ||
423 | Controlled by the | ||
424 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>, | ||
425 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>, | ||
426 | and | ||
427 | <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> | ||
428 | variables. | ||
429 | </para></listitem> | ||
430 | <listitem><para> | ||
431 | <emphasis>Target Machine Selection:</emphasis> | 423 | <emphasis>Target Machine Selection:</emphasis> |
432 | Controlled by the | 424 | Controlled by the |
433 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> | 425 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> |
@@ -451,6 +443,30 @@ | |||
451 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> | 443 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> |
452 | variable. | 444 | variable. |
453 | </para></listitem> | 445 | </para></listitem> |
446 | <listitem><para> | ||
447 | <emphasis>Distribution Policy:</emphasis> | ||
448 | Controlled by the | ||
449 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO'><filename>DISTRO</filename></ulink> | ||
450 | variable. | ||
451 | </para></listitem> | ||
452 | <listitem><para> | ||
453 | <emphasis>Packaging Format:</emphasis> | ||
454 | Controlled by the | ||
455 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink> | ||
456 | variable. | ||
457 | </para></listitem> | ||
458 | <listitem><para> | ||
459 | <emphasis>SDK Target Architecture:</emphasis> | ||
460 | Controlled by the | ||
461 | <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink> | ||
462 | variable. | ||
463 | </para></listitem> | ||
464 | <listitem><para> | ||
465 | <emphasis>Extra Image Packages:</emphasis> | ||
466 | Controlled by the | ||
467 | <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> | ||
468 | variable. | ||
469 | </para></listitem> | ||
454 | </itemizedlist> | 470 | </itemizedlist> |
455 | <note> | 471 | <note> |
456 | Configurations set in the | 472 | Configurations set in the |
@@ -540,7 +556,9 @@ | |||
540 | <filename>site.conf</filename>, <filename>auto.conf</filename>, | 556 | <filename>site.conf</filename>, <filename>auto.conf</filename>, |
541 | and <filename>local.conf</filename>. | 557 | and <filename>local.conf</filename>. |
542 | And, the build system applies the normal assignment statement | 558 | And, the build system applies the normal assignment statement |
543 | rules. | 559 | rules as described in the |
560 | "<ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata'>Syntax and Operators</ulink>" | ||
561 | chapter of the BitBake User Manual. | ||
544 | Because the files are parsed in a specific order, variable | 562 | Because the files are parsed in a specific order, variable |
545 | assignments for the same variable could be affected. | 563 | assignments for the same variable could be affected. |
546 | For example, if the <filename>auto.conf</filename> file and | 564 | For example, if the <filename>auto.conf</filename> file and |
@@ -594,7 +612,7 @@ | |||
594 | The following figure shows an expanded representation of the | 612 | The following figure shows an expanded representation of the |
595 | Metadata, Machine Configuration, and Policy Configuration input | 613 | Metadata, Machine Configuration, and Policy Configuration input |
596 | (layers) boxes of the | 614 | (layers) boxes of the |
597 | <link linkend='general-yocto-environment-figure'>general Build Process figure</link>: | 615 | <link linkend='general-workflow-figure'>general workflow figure</link>: |
598 | </para> | 616 | </para> |
599 | 617 | ||
600 | <para> | 618 | <para> |
@@ -757,7 +775,7 @@ | |||
757 | In order for the OpenEmbedded build system to create an | 775 | In order for the OpenEmbedded build system to create an |
758 | image or any target, it must be able to access source files. | 776 | image or any target, it must be able to access source files. |
759 | The | 777 | The |
760 | <link linkend='general-yocto-environment-figure'>general Build Process figure</link> | 778 | <link linkend='general-workflow-figure'>general workflow figure</link> |
761 | represents source files using the "Upstream Project Releases", | 779 | represents source files using the "Upstream Project Releases", |
762 | "Local Projects", and "SCMs (optional)" boxes. | 780 | "Local Projects", and "SCMs (optional)" boxes. |
763 | The figure represents mirrors, which also play a role in | 781 | The figure represents mirrors, which also play a role in |
@@ -821,7 +839,7 @@ | |||
821 | The remainder of this section provides a deeper look into the | 839 | The remainder of this section provides a deeper look into the |
822 | source files and the mirrors. | 840 | source files and the mirrors. |
823 | Here is a more detailed look at the source file area of the | 841 | Here is a more detailed look at the source file area of the |
824 | <link linkend='general-yocto-environment-figure'>general Build Process figure</link>: | 842 | <link linkend='general-workflow-figure'>general workflow figure</link>: |
825 | <imagedata fileref="figures/source-input.png" align="center" width="7in" depth="7.5in" /> | 843 | <imagedata fileref="figures/source-input.png" align="center" width="7in" depth="7.5in" /> |
826 | </para> | 844 | </para> |
827 | 845 | ||
@@ -934,7 +952,7 @@ | |||
934 | in the | 952 | in the |
935 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. | 953 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. |
936 | The | 954 | The |
937 | <link linkend='general-yocto-environment-figure'>general Build Process figure</link> | 955 | <link linkend='general-workflow-figure'>general workflow figure</link> |
938 | shows this package feeds area in the upper-right corner. | 956 | shows this package feeds area in the upper-right corner. |
939 | </para> | 957 | </para> |
940 | 958 | ||
@@ -1028,7 +1046,7 @@ | |||
1028 | <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink> | 1046 | <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink> |
1029 | to produce images. | 1047 | to produce images. |
1030 | You can see from the | 1048 | You can see from the |
1031 | <link linkend='general-yocto-environment-figure'>general Build Process figure</link>, | 1049 | <link linkend='general-workflow-figure'>general workflow figure</link>, |
1032 | the BitBake area consists of several functional areas. | 1050 | the BitBake area consists of several functional areas. |
1033 | This section takes a closer look at each of those areas. | 1051 | This section takes a closer look at each of those areas. |
1034 | </para> | 1052 | </para> |
@@ -1785,7 +1803,7 @@ | |||
1785 | are compressed forms of the | 1803 | are compressed forms of the |
1786 | root filesystem that are ready to boot on a target device. | 1804 | root filesystem that are ready to boot on a target device. |
1787 | You can see from the | 1805 | You can see from the |
1788 | <link linkend='general-yocto-environment-figure'>general Build Process figure</link> | 1806 | <link linkend='general-workflow-figure'>general workflow figure</link> |
1789 | that BitBake output, in part, consists of images. | 1807 | that BitBake output, in part, consists of images. |
1790 | This section is going to look more closely at this output: | 1808 | This section is going to look more closely at this output: |
1791 | <imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" /> | 1809 | <imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" /> |
@@ -1881,7 +1899,7 @@ | |||
1881 | 1899 | ||
1882 | <para> | 1900 | <para> |
1883 | In the | 1901 | In the |
1884 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>, | 1902 | <link linkend='general-workflow-figure'>general Yocto Project Development Environment figure</link>, |
1885 | the output labeled "Application Development SDK" represents an | 1903 | the output labeled "Application Development SDK" represents an |
1886 | SDK. | 1904 | SDK. |
1887 | The SDK generation process differs depending on whether you | 1905 | The SDK generation process differs depending on whether you |