summaryrefslogtreecommitdiffstats
path: root/poky/documentation/ref-manual
diff options
context:
space:
mode:
authorBrad Bishop <bradleyb@fuzziesquirrel.com>2019-04-05 15:28:33 -0400
committerBrad Bishop <bradleyb@fuzziesquirrel.com>2019-04-05 19:31:28 +0000
commit193236933b0f4ab91b1625b64e2187e2db4e0e8f (patch)
treee12769d7c76d8b0517d6de3d3c72189753d253ed /poky/documentation/ref-manual
parentbd93df9478f2f56ffcbc8cb88f1709c735dcd85b (diff)
downloadtalos-openbmc-193236933b0f4ab91b1625b64e2187e2db4e0e8f.tar.gz
talos-openbmc-193236933b0f4ab91b1625b64e2187e2db4e0e8f.zip
reset upstream subtrees to HEAD
Reset the following subtrees on HEAD: poky: 8217b477a1(master) meta-xilinx: 64aa3d35ae(master) meta-openembedded: 0435c9e193(master) meta-raspberrypi: 490a4441ac(master) meta-security: cb6d1c85ee(master) Squashed patches: meta-phosphor: drop systemd 239 patches meta-phosphor: mrw-api: use correct install path Change-Id: I268e2646d9174ad305630c6bbd3fbc1a6105f43d Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
Diffstat (limited to 'poky/documentation/ref-manual')
-rw-r--r--poky/documentation/ref-manual/ref-manual.xml4
-rw-r--r--poky/documentation/ref-manual/ref-system-requirements.xml83
-rw-r--r--poky/documentation/ref-manual/ref-variables.xml211
-rw-r--r--poky/documentation/ref-manual/resources.xml2
4 files changed, 134 insertions, 166 deletions
diff --git a/poky/documentation/ref-manual/ref-manual.xml b/poky/documentation/ref-manual/ref-manual.xml
index f834d2dea..26295f02f 100644
--- a/poky/documentation/ref-manual/ref-manual.xml
+++ b/poky/documentation/ref-manual/ref-manual.xml
@@ -128,9 +128,9 @@
<revremark>Released with the Yocto Project 2.6 Release.</revremark>
</revision>
<revision>
- <revnumber>2.6.1</revnumber>
+ <revnumber>2.7</revnumber>
<date>&REL_MONTH_YEAR;</date>
- <revremark>Released with the Yocto Project 2.6.1 Release.</revremark>
+ <revremark>Released with the Yocto Project 2.7 Release.</revremark>
</revision>
</revhistory>
diff --git a/poky/documentation/ref-manual/ref-system-requirements.xml b/poky/documentation/ref-manual/ref-system-requirements.xml
index 0db84e31f..5f2b9f6ce 100644
--- a/poky/documentation/ref-manual/ref-system-requirements.xml
+++ b/poky/documentation/ref-manual/ref-system-requirements.xml
@@ -97,18 +97,9 @@
<listitem><para>OpenSUSE 42.3</para></listitem>
</itemizedlist>
</para>
-<!--
-Checkout the poky distro you are interested in (by branch or tag).
-From the poky directory, run the script:
-
-bitbake -e | grep ^SANITY_TESTED_DISTROS | sed -e 's/.*"\(.*\)".*/\1/g' -e 's!\\n!\n!g' | sed 's/^[\t]*//;s/[ \t]*$//' | grep -v Poky
-
-This returns a list of the supported distros for the release.
-
-Here is some old list items to show the form:
- <listitem><para>Ubuntu 10.04</para></listitem>
+<!-- <listitem><para>Ubuntu 10.04</para></listitem>
<listitem><para>Ubuntu 11.10</para></listitem>
<listitem><para>Ubuntu 12.04 (LTS)</para></listitem>
<listitem><para>Ubuntu 13.10</para></listitem>
@@ -151,8 +142,10 @@ Here is some old list items to show the form:
<listitem><para>openSUSE 13.2</para></listitem>
<listitem><para>openSUSE 42.1</para></listitem>
<listitem><para>openSUSE 42.2</para></listitem>
+ </itemizedlist>
-->
+
<note>
While the Yocto Project Team attempts to ensure all Yocto Project
releases are one hundred percent compatible with each officially
@@ -199,26 +192,12 @@ Here is some old list items to show the form:
<literallayout class='monospaced'>
$ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
</literallayout></para></listitem>
- <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis>
- Packages recommended if the host system has graphics
- support or if you are going to use the Eclipse
- IDE:
- <literallayout class='monospaced'>
- $ sudo apt-get install libsdl1.2-dev xterm
- </literallayout></para></listitem>
<listitem><para><emphasis>Documentation:</emphasis>
Packages needed if you are going to build out the
Yocto Project documentation manuals:
<literallayout class='monospaced'>
$ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto
</literallayout></para></listitem>
- <listitem><para><emphasis>OpenEmbedded Self-Test (<filename>oe-selftest</filename>):</emphasis>
- Packages needed if you are going to run
- <filename>oe-selftest</filename>:
- <literallayout class='monospaced'>
- $ sudo apt-get install python-git
- </literallayout>
- </para></listitem>
</itemizedlist>
</para>
</section>
@@ -236,27 +215,13 @@ Here is some old list items to show the form:
<literallayout class='monospaced'>
$ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL;
</literallayout></para></listitem>
- <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis>
- Packages recommended if the host system has graphics
- support or if you are going to use the Eclipse
- IDE:
- <literallayout class='monospaced'>
- $ sudo dnf install SDL-devel xterm
- </literallayout></para></listitem>
<listitem><para><emphasis>Documentation:</emphasis>
Packages needed if you are going to build out the
Yocto Project documentation manuals:
<literallayout class='monospaced'>
- $ sudo dnf install make docbook-style-dsssl docbook-style-xsl \
+ $ sudo dnf install docbook-style-dsssl docbook-style-xsl \
docbook-dtds docbook-utils fop libxslt dblatex xmlto
</literallayout></para></listitem>
- <listitem><para><emphasis>OpenEmbedded Self-Test (<filename>oe-selftest</filename>):</emphasis>
- Packages needed if you are going to run
- <filename>oe-selftest</filename>:
- <literallayout class='monospaced'>
- $ sudo dnf install python3-GitPython
- </literallayout>
- </para></listitem>
</itemizedlist>
</para>
</section>
@@ -274,33 +239,13 @@ Here is some old list items to show the form:
<literallayout class='monospaced'>
$ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
</literallayout></para></listitem>
- <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis>
- Packages recommended if the host system has graphics
- support or if you are going to use the Eclipse
- IDE:
- <literallayout class='monospaced'>
- $ sudo zypper install libSDL-devel xterm
- </literallayout></para></listitem>
<listitem><para><emphasis>Documentation:</emphasis>
Packages needed if you are going to build out the
Yocto Project documentation manuals:
<literallayout class='monospaced'>
- $ sudo zypper install make dblatex xmlto
- </literallayout></para></listitem>
- <listitem><para><emphasis>OpenEmbedded Self-Test (<filename>oe-selftest</filename>):</emphasis>
- Packages needed if you are going to run
- <filename>oe-selftest</filename>:
- <literallayout class='monospaced'>
- $ sudo zypper install python-GitPython
+ $ sudo zypper install dblatex xmlto
</literallayout></para></listitem>
</itemizedlist>
- <note>
- Sanity testing, through the
- <link linkend='ref-classes-testimage*'>testimage</link>
- classes, does not work on systems using the
- <ulink url='https://en.opensuse.org/Portal:Wicked'>Wicked</ulink>
- network manager.
- </note>
</para>
</section>
@@ -315,7 +260,7 @@ Here is some old list items to show the form:
Packages needed to build an image for a headless
system:
<literallayout class='monospaced'>
- $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
+ $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL;
</literallayout>
<note><title>Notes</title>
<itemizedlist>
@@ -337,27 +282,13 @@ Here is some old list items to show the form:
</itemizedlist>
</note>
</para></listitem>
- <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis>
- Packages recommended if the host system has graphics
- support or if you are going to use the Eclipse
- IDE:
- <literallayout class='monospaced'>
- $ sudo yum install SDL-devel xterm
- </literallayout></para></listitem>
<listitem><para><emphasis>Documentation:</emphasis>
Packages needed if you are going to build out the
Yocto Project documentation manuals:
<literallayout class='monospaced'>
- $ sudo yum install make docbook-style-dsssl docbook-style-xsl \
+ $ sudo yum install docbook-style-dsssl docbook-style-xsl \
docbook-dtds docbook-utils fop libxslt dblatex xmlto
</literallayout></para></listitem>
- <listitem><para><emphasis>OpenEmbedded Self-Test (<filename>oe-selftest</filename>):</emphasis>
- Packages needed if you are going to run
- <filename>oe-selftest</filename>:
- <literallayout class='monospaced'>
- $ sudo yum install GitPython
- </literallayout>
- </para></listitem>
</itemizedlist>
</para>
</section>
diff --git a/poky/documentation/ref-manual/ref-variables.xml b/poky/documentation/ref-manual/ref-variables.xml
index 9f6bc1ada..6470c739c 100644
--- a/poky/documentation/ref-manual/ref-variables.xml
+++ b/poky/documentation/ref-manual/ref-variables.xml
@@ -3621,60 +3621,6 @@
</glossdef>
</glossentry>
- <glossentry id='var-DISK_SIGNATURE'><glossterm>DISK_SIGNATURE</glossterm>
- <info>
- DISK_SIGNATURE[doc] = "A 32-bit MBR disk signature used by directdisk images."
- </info>
- <glossdef>
- <para role="glossdeffirst">
-<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
- A 32-bit MBR disk signature used by
- <filename>directdisk</filename> images.
- </para>
-
- <para>
- By default, the signature is set to an automatically
- generated random value that allows the OpenEmbedded
- build system to create a boot loader.
- You can override the signature in the image recipe
- by setting <filename>DISK_SIGNATURE</filename> to an
- 8-digit hex string.
- You might want to override
- <filename>DISK_SIGNATURE</filename> if you want the disk
- signature to remain constant between image builds.
- </para>
-
- <para>
- When using Linux 3.8 or later, you can use
- <filename>DISK_SIGNATURE</filename> to specify the root
- by UUID to allow the kernel to locate the root device
- even if the device name changes due to differences in
- hardware configuration.
- By default, <filename>ROOT_VM</filename> is set
- as follows:
- <literallayout class='monospaced'>
- ROOT_VM ?= "root=/dev/sda2"
- </literallayout>
- However, you can change this to locate the root device
- using the disk signature instead:
- <literallayout class='monospaced'>
- ROOT_VM = "root=PARTUUID=${DISK_SIGNATURE}-02"
- </literallayout>
- </para>
-
- <para>
- As previously mentioned, it is possible to set the
- <filename>DISK_SIGNATURE</filename> variable in your
- <filename>local.conf</filename> file to a fixed
- value if you do not want <filename>syslinux.cfg</filename>
- changing for each build.
- You might find this useful when you want to upgrade the
- root filesystem on a device without having to recreate or
- modify the master boot record.
- </para>
- </glossdef>
- </glossentry>
-
<glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
<info>
DISTRO[doc] = "The short name of the distribution. If the variable is blank, meta/conf/distro/defaultsetup.conf will be used."
@@ -3877,7 +3823,7 @@
<filename>DISTRO_FEATURES_DEFAULT</filename> from a
custom distro configuration file:
<literallayout class='monospaced'>
- DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${DISTRO_FEATURES_LIBC} myfeature"
+ DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature"
</literallayout>
</para>
</glossdef>
@@ -3924,13 +3870,14 @@
</glossdef>
</glossentry>
+<!--
<glossentry id='var-DISTRO_FEATURES_LIBC'><glossterm>DISTRO_FEATURES_LIBC</glossterm>
<info>
DISTRO_FEATURES_LIBC[doc] = "Specifies the list of distro features that are specific to the C library (libc)."
</info>
<glossdef>
<para role="glossdeffirst">
-<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+ <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" />
A convenience variable that specifies the list of distro
features that are specific to the C library
(<filename>libc</filename>).
@@ -3940,6 +3887,7 @@
</para>
</glossdef>
</glossentry>
+-->
<glossentry id='var-DISTRO_FEATURES_NATIVE'><glossterm>DISTRO_FEATURES_NATIVE</glossterm>
<info>
@@ -5012,9 +4960,17 @@
A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
used by the OpenEmbedded build system for creating
<link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>.
- You can find more information on how overrides are handled
- in the
- <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>.
+ The <filename>FILESOVERRIDES</filename> variable uses
+ overrides to automatically extend the
+ <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
+ variable.
+ For an example of how that works, see the
+ <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
+ variable description.
+ Additionally, you find more information on how overrides
+ are handled in the
+ "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>"
+ section of the BitBake User Manual.
</para>
<para>
@@ -5041,11 +4997,14 @@
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
- The default set of directories the OpenEmbedded build system
- uses when searching for patches and files.
- During the build process, BitBake searches each directory in
- <filename>FILESPATH</filename> in the specified order when
- looking for files and patches specified by each
+ The default set of directories the OpenEmbedded build
+ system uses when searching for patches and files.
+ </para>
+
+ <para>
+ During the build process, BitBake searches each directory
+ in <filename>FILESPATH</filename> in the specified order
+ when looking for files and patches specified by each
<filename>file://</filename> URI in a recipe's
<link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
statements.
@@ -5060,23 +5019,62 @@
FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
"${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
</literallayout>
- <note>
- Do not hand-edit the <filename>FILESPATH</filename>
- variable.
- If you want the build system to look in directories
- other than the defaults, extend the
- <filename>FILESPATH</filename> variable by using the
- <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
- variable.
+ The <filename>FILESPATH</filename> variable is automatically
+ extended using the overrides from the
+ <link linkend='var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></link>
+ variable.
+ <note><title>Notes</title>
+ <itemizedlist>
+ <listitem><para>
+ Do not hand-edit the
+ <filename>FILESPATH</filename> variable.
+ If you want the build system to look in
+ directories other than the defaults, extend the
+ <filename>FILESPATH</filename> variable by
+ using the
+ <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
+ variable.
+ </para></listitem>
+ <listitem><para>
+ Be aware that the default
+ <filename>FILESPATH</filename> directories do
+ not map to directories in custom layers
+ where append files
+ (<filename>.bbappend</filename>) are used.
+ If you want the build system to find patches
+ or files that reside with your append files,
+ you need to extend the
+ <filename>FILESPATH</filename> variable by
+ using the <filename>FILESEXTRAPATHS</filename>
+ variable.
+ </para></listitem>
+ </itemizedlist>
</note>
- Be aware that the default <filename>FILESPATH</filename>
- directories do not map to directories in custom layers
- where append files (<filename>.bbappend</filename>)
- are used.
- If you want the build system to find patches or files
- that reside with your append files, you need to extend
- the <filename>FILESPATH</filename> variable by using
- the <filename>FILESEXTRAPATHS</filename> variable.
+ </para>
+
+ <para>
+ You can take advantage of this searching behavior in
+ useful ways.
+ For example, consider a case where the following
+ directory structure exists for general and machine-specific
+ configurations:
+ <literallayout class='monospaced'>
+ files/defconfig
+ files/MACHINEA/defconfig
+ files/MACHINEB/defconfig
+ </literallayout>
+ Also in the example, the <filename>SRC_URI</filename>
+ statement contains "file://defconfig".
+ Given this scenario, you can set
+ <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
+ to "MACHINEA" and cause the build system to use files
+ from <filename>files/MACHINEA</filename>.
+ Set <filename>MACHINE</filename> to "MACHINEB" and the
+ build system uses files from
+ <filename>files/MACHINEB</filename>.
+ Finally, for any machine other than "MACHINEA" and
+ "MACHINEB", the build system uses files from
+ <filename>files/defconfig</filename>.
</para>
<para>
@@ -6076,11 +6074,12 @@
<note><title>Notes</title>
<itemizedlist>
<listitem><para>
- If you add "live" to
- <filename>IMAGE_FSTYPES</filename> inside an image
- recipe, be sure that you do so prior to the
- "inherit image" line of the recipe or the live
- image will not build.
+ If an image recipe uses the "inherit image" line
+ and you are setting
+ <filename>IMAGE_FSTYPES</filename> inside the
+ recipe, you must set
+ <filename>IMAGE_FSTYPES</filename> prior to
+ using the "inherit image" line.
</para></listitem>
<listitem><para>
Due to the way the OpenEmbedded build system
@@ -6866,6 +6865,44 @@
</glossdef>
</glossentry>
+ <glossentry id='var-INHIBIT_SYSROOT_STRIP'><glossterm>INHIBIT_SYSROOT_STRIP</glossterm>
+ <info>
+ INHIBIT_SYSROOT_STRIP[doc] = "If set to "1", causes the build to not strip binaries in the resulting sysroot."
+ </info>
+ <glossdef>
+ <para role="glossdeffirst">
+<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+ If set to "1", causes the build to not strip binaries in
+ the resulting sysroot.
+ </para>
+
+ <para>
+ By default, the OpenEmbedded build system strips
+ binaries in the resulting sysroot.
+ When you specifically set the
+ <filename>INHIBIT_SYSROOT_STRIP</filename> variable to
+ "1" in your recipe, you inhibit this stripping.
+ </para>
+
+ <para>
+ If you want to use this variable, include the
+ <link linkend='ref-classes-staging'><filename>staging</filename></link>
+ class.
+ This class uses a <filename>sys_strip()</filename>
+ function to test for the variable and acts accordingly.
+ <note>
+ Use of the <filename>INHIBIT_SYSROOT_STRIP</filename>
+ variable occurs in rare and special circumstances.
+ For example, suppose you are building bare-metal
+ firmware by using an external GCC toolchain.
+ Furthermore, even if the toolchain's binaries are
+ strippable, other files exist that are needed for the
+ build that are not strippable.
+ </note>
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm>
<info>
INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM filesystem (initramfs), which is used during boot."
@@ -9933,7 +9970,6 @@
<filename>/bin/.debug</filename>.
Source files are placed in
<filename>/usr/src/debug</filename>.
- This is the default behavior.
</para></listitem>
<listitem><para>
"debug-file-directory": Debug symbol files are
@@ -9957,6 +9993,7 @@
".debug" previously described with the exception
that all source files are placed in a separate
<filename>*-src</filename> pkg.
+ This is the default behavior.
</para></listitem>
</itemizedlist>
</para>
@@ -13002,7 +13039,7 @@
<filename>/meta-poky/conf/distro/poky.conf</filename>)
defines the <filename>SDK_VERSION</filename> as follows:
<literallayout class='monospaced'>
- SDK_VERSION := "${@'${DISTRO_VERSION}'.replace('snapshot-${DATE}','snapshot')}"
+ SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}"
</literallayout>
</para>
diff --git a/poky/documentation/ref-manual/resources.xml b/poky/documentation/ref-manual/resources.xml
index be0469616..6a0cee8a5 100644
--- a/poky/documentation/ref-manual/resources.xml
+++ b/poky/documentation/ref-manual/resources.xml
@@ -155,7 +155,7 @@
</para></listitem>
<listitem><para>
<emphasis>
- <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink>
+ <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>:
</emphasis>
A comprehensive guide to the BitBake tool.
If you want information on BitBake, see this manual.
OpenPOWER on IntegriCloud