mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-02 01:19:52 +00:00
Code Issues Projects Releases Wiki Activity

overview-manual: Updates to "User Configuration" section.

Browse Source 
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>
This commit is contained in:
Scott Rifenbark
2018-04-25 11:45:44 -07:00
committed by Richard Purdie
parent edd28ad3c9
commit 98c0b1ea5d
1 changed files with 51 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/overview-manual/overview-manual-concepts.xml
+51 -33
View File
@@ -251,13 +251,14 @@
</para> </para>
<para> <para>
The following diagram represents a build at a high level. The following diagram represents the high-level workflow of a
build.
The remainder of this section expands on the fundamental input, The remainder of this section expands on the fundamental input,
output, process, and metadata logical blocks that make up the output, process, and metadata logical blocks that make up the
OpenEmbedded build system's workflow. workflow.
</para> </para>
<para id='general-yocto-environment-figure'> <para id='general-workflow-figure'>
<imagedata fileref="figures/YP-flow-diagram.png" format="PNG" align='center' width="8in"/> <imagedata fileref="figures/YP-flow-diagram.png" format="PNG" align='center' width="8in"/>
</para> </para>
@@ -323,7 +324,7 @@
<para> <para>
The following figure shows an expanded representation of the The following figure shows an expanded representation of the
"User Configuration" box of the "User Configuration" box of the
<link linkend='general-yocto-environment-figure'>general Build Process figure</link>: <link linkend='general-workflow-figure'>general workflow figure</link>:
</para> </para>
<para> <para>
@@ -335,21 +336,22 @@
complete a build. complete a build.
These files are <filename>*.conf</filename> files. These files are <filename>*.conf</filename> files.
The minimally necessary ones reside as example files in the The minimally necessary ones reside as example files in the
<filename>build/conf</filename> directory of the
<ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>.
For simplicity, this section refers to the Source Directory as For simplicity, this section refers to the Source Directory as
the "Poky Directory." the "Poky Directory."
</para> </para>
<para> <para>
When you clone the <filename>poky</filename> Git repository When you clone the
or you download and unpack a Yocto Project release, you <ulink url='&YOCTO_DOCS_REF_URL;#poky'>Poky</ulink>
can set up the Source Directory to be named anything you want. Git repository or you download and unpack a Yocto Project
release, you can set up the Source Directory to be named
anything you want.
For this discussion, the cloned repository uses the default For this discussion, the cloned repository uses the default
name <filename>poky</filename>. name <filename>poky</filename>.
<note> <note>
The The Poky repository is primarily an aggregation of existing
<ulink url='&YOCTO_DOCS_REF_URL;#poky'>Poky</ulink>
repository is primarily an aggregation of existing
repositories. repositories.
It is not a canonical upstream source. It is not a canonical upstream source.
</note> </note>
@@ -360,10 +362,9 @@
a <filename>conf</filename> directory that has example a <filename>conf</filename> directory that has example
configuration files. configuration files.
These example files are used as a basis for creating actual These example files are used as a basis for creating actual
configuration files when you source the build environment configuration files when you source
script <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>,
(i.e. which is the build environment script.
<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>).
</para> </para>
<para> <para>
@@ -415,18 +416,9 @@
To see the default configurations in a To see the default configurations in a
<filename>local.conf</filename> file created by the build <filename>local.conf</filename> file created by the build
environment script, see the environment script, see the
<filename>local.conf.sample</filename> in the <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample'><filename>local.conf.sample</filename></ulink>
<filename>meta-poky</filename> layer: in the <filename>meta-poky</filename> layer:
<itemizedlist> <itemizedlist>
<listitem><para>
<emphasis>Parallelism Options:</emphasis>
Controlled by the
<ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>,
<ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>,
and
<ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink>
variables.
</para></listitem>
<listitem><para> <listitem><para>
<emphasis>Target Machine Selection:</emphasis> <emphasis>Target Machine Selection:</emphasis>
Controlled by the Controlled by the
@@ -451,6 +443,30 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>
variable. variable.
</para></listitem> </para></listitem>
<listitem><para>
<emphasis>Distribution Policy:</emphasis>
Controlled by the
<ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO'><filename>DISTRO</filename></ulink>
variable.
</para></listitem>
<listitem><para>
<emphasis>Packaging Format:</emphasis>
Controlled by the
<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>
variable.
</para></listitem>
<listitem><para>
<emphasis>SDK Target Architecture:</emphasis>
Controlled by the
<ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>
variable.
</para></listitem>
<listitem><para>
<emphasis>Extra Image Packages:</emphasis>
Controlled by the
<ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>
variable.
</para></listitem>
</itemizedlist> </itemizedlist>
<note> <note>
Configurations set in the Configurations set in the
@@ -540,7 +556,9 @@
<filename>site.conf</filename>, <filename>auto.conf</filename>, <filename>site.conf</filename>, <filename>auto.conf</filename>,
and <filename>local.conf</filename>. and <filename>local.conf</filename>.
And, the build system applies the normal assignment statement And, the build system applies the normal assignment statement
rules. rules as described in the
"<ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata'>Syntax and Operators</ulink>"
chapter of the BitBake User Manual.
Because the files are parsed in a specific order, variable Because the files are parsed in a specific order, variable
assignments for the same variable could be affected. assignments for the same variable could be affected.
For example, if the <filename>auto.conf</filename> file and For example, if the <filename>auto.conf</filename> file and
@@ -594,7 +612,7 @@
The following figure shows an expanded representation of the The following figure shows an expanded representation of the
Metadata, Machine Configuration, and Policy Configuration input Metadata, Machine Configuration, and Policy Configuration input
(layers) boxes of the (layers) boxes of the
<link linkend='general-yocto-environment-figure'>general Build Process figure</link>: <link linkend='general-workflow-figure'>general workflow figure</link>:
</para> </para>
<para> <para>
@@ -757,7 +775,7 @@
In order for the OpenEmbedded build system to create an In order for the OpenEmbedded build system to create an
image or any target, it must be able to access source files. image or any target, it must be able to access source files.
The The
<link linkend='general-yocto-environment-figure'>general Build Process figure</link> <link linkend='general-workflow-figure'>general workflow figure</link>
represents source files using the "Upstream Project Releases", represents source files using the "Upstream Project Releases",
"Local Projects", and "SCMs (optional)" boxes. "Local Projects", and "SCMs (optional)" boxes.
The figure represents mirrors, which also play a role in The figure represents mirrors, which also play a role in
@@ -821,7 +839,7 @@
The remainder of this section provides a deeper look into the The remainder of this section provides a deeper look into the
source files and the mirrors. source files and the mirrors.
Here is a more detailed look at the source file area of the Here is a more detailed look at the source file area of the
<link linkend='general-yocto-environment-figure'>general Build Process figure</link>: <link linkend='general-workflow-figure'>general workflow figure</link>:
<imagedata fileref="figures/source-input.png" align="center" width="7in" depth="7.5in" /> <imagedata fileref="figures/source-input.png" align="center" width="7in" depth="7.5in" />
</para> </para>
@@ -934,7 +952,7 @@
in the in the
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
The The
<link linkend='general-yocto-environment-figure'>general Build Process figure</link> <link linkend='general-workflow-figure'>general workflow figure</link>
shows this package feeds area in the upper-right corner. shows this package feeds area in the upper-right corner.
</para> </para>
@@ -1028,7 +1046,7 @@
<ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink> <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink>
to produce images. to produce images.
You can see from the You can see from the
<link linkend='general-yocto-environment-figure'>general Build Process figure</link>, <link linkend='general-workflow-figure'>general workflow figure</link>,
the BitBake area consists of several functional areas. the BitBake area consists of several functional areas.
This section takes a closer look at each of those areas. This section takes a closer look at each of those areas.
</para> </para>
@@ -1785,7 +1803,7 @@
are compressed forms of the are compressed forms of the
root filesystem that are ready to boot on a target device. root filesystem that are ready to boot on a target device.
You can see from the You can see from the
<link linkend='general-yocto-environment-figure'>general Build Process figure</link> <link linkend='general-workflow-figure'>general workflow figure</link>
that BitBake output, in part, consists of images. that BitBake output, in part, consists of images.
This section is going to look more closely at this output: This section is going to look more closely at this output:
<imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" /> <imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" />
@@ -1881,7 +1899,7 @@
<para> <para>
In the In the
<link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>, <link linkend='general-workflow-figure'>general Yocto Project Development Environment figure</link>,
the output labeled "Application Development SDK" represents an the output labeled "Application Development SDK" represents an
SDK. SDK.
The SDK generation process differs depending on whether you The SDK generation process differs depending on whether you