summaryrefslogtreecommitdiff
path: root/poky/documentation/ref-manual/images.rst
diff options
context:
space:
mode:
authorAndrew Geissler <geissonator@yahoo.com>2020-12-13 17:44:15 +0300
committerAndrew Geissler <geissonator@yahoo.com>2020-12-15 21:53:47 +0300
commit09209eec235a35b7089db987561c12e9bd023237 (patch)
tree2d3580484ffacafe11b72e9abaab50a428dd617d /poky/documentation/ref-manual/images.rst
parentf7ba29eda266e04f867e4338b6b8b10c1969419c (diff)
downloadopenbmc-09209eec235a35b7089db987561c12e9bd023237.tar.xz
poky: subtree update:0ac99625bf..796be0593a
Alexander Kanavin (31): netbase: upgrade 6.1 -> 6.2 meson: upgrade 0.55.1 -> 0.56.0 vulkan-samples: update to latest revision libcap: update 2.44 -> 2.45 bind: upgrade 9.16.7 -> 9.16.9 quota: upgrade 4.05 -> 4.06 pango: upgrade 1.46.2 -> 1.48.0 elfutils: upgrade 0.181 -> 0.182 ifupdown: upgrade 0.8.35 -> 0.8.36 createrepo-c: upgrade 0.16.1 -> 0.16.2 acpica: upgrade 20200925 -> 20201113 grep: upgrade 3.5 -> 3.6 man-pages: upgrade 5.08 -> 5.09 stress-ng: upgrade 0.11.23 -> 0.11.24 libhandy: upgrade 1.0.1 -> 1.0.2 piglit: upgrade to latest revision xkbcomp: upgrade 1.4.3 -> 1.4.4 lz4: upgrade 1.9.2 -> 1.9.3 bison: upgrade 3.7.3 -> 3.7.4 python3-setuptools-scm: fix upstream version check cantarell-fonts: update 0.0.25 -> 0.201 meta/lib/oe/reproducible.py: gitsm:// works just as fine as git:// for timestamps llvm: fix reproducibility ruby: fix reproducibility webkitgtk: fix reproducibility ffmpeg: fix reproducibility piglit: fix reproducibility serf: do not install the static library llvm: sort the lists in generated source reproducibibly kea: fix reproducibility poky.conf: do not write current date into distro version, use git hash instead Andrej Valek (1): kernel-dummy: fix executing unexpected tasks Anuj Mittal (1): releases.rst: add gatesgarth to current releases Brett Warren (1): libffi: add patch to revert clang VFP workaround Chandana kalluri (1): populate_sdk_ext: use SDK_CUSTOM_TEPLATECONF variable to enable custom templateconf.cfg Changqing Li (1): buildtools-tarball: add wic dependency into extended buildtools Diego Sueiro (2): modutils-initscripts: Fix modules.dep creation when USE_DEPMOD="0" initscripts: Change execution order between checkroot and modutils Dmitry Baryshkov (2): linux-firmware: upgrade 20201022 -> 20201118 linux-firmware: package ath11k firmware Fabio Berton (1): mesa: Update 20.2.1 -> 20.2.4 Gratian Crisan (1): kernel-module-split.bbclass: fix kernel modules getting marked as CONFFILES Jack Mitchell (3): Revert "connman: set service to conflict with systemd-networkd" systemd-conf: add PACKAGECONFIG to enable/disable auto ethernet DHCP systemd-conf: match ethernet interfaces by type rather than globbing Joshua Watt (2): bitbake: hashserv: client: Fix AF_UNIX path length limits bitbake: hashserv: Fix broken AF_UNIX path length limit Kai Kang (2): systemd-systemctl-native: capable to call without argument systemd.bbclass: update command to check systemctl available Kevin Hao (1): tune-octeontx2.inc: Add tune for Marvell OCTEON TX2 core Li Wang (2): qemu: CVE-2020-29129 CVE-2020-29130 qemu: CVE-2020-25624 Luca Boccassi (1): dbus: move messagebus user to dbus-common package Michael Halstead (1): releases: conf: add link to 3.1.4, update to include 3.1.4 Nicolas Dechesne (19): sphinx: add .vscode in .gitignore {dev,kernel,sdk}-manual: replace hardcoded release version with &DISTRO; sphinx: replace bitbake labels with references to corresponding title brief-yoctoprojectqs: replace labels with references to section title dev-manual: replace labels with references to section title ref-manual: replace labels with references to section title sdk-manual: replace labels with references to section title overview-manual: remove unused labels dev-manual: remove unused labels sphinx: rename top level document in each manual sphinx: use absolute paths for :doc: references test-manual: remove 'test-manual' from filenames toaster-manual: remove 'toaster-manual' from filenames dev-manual: remove 'dev-manual' from filenames kernel-dev: remove 'kernel-dev' from filenames profile-manual: remove 'profile-manual' from filenames overview-manual: remove 'overview-manual' from filenames sdk-manual: remove 'sdk' from filenames ref-manual: remove 'ref' from filenames Paul Barker (5): documentation: Simplify yocto_wiki links documentation: Simplify yocto_git links ref-manual: Simplify oe_git links poky.conf: Add opensuseleap-15.2 and fedora-33 to tested distros poky.conf: Drop fedora-30 from tested distros Peter Kjellerstedt (2): pseudo: Simplify pseudo_client_ignore_path_chroot() bitbake.conf: Add all layers (from BBLAYERS) to PSEUDO_IGNORE_PATHS Richard Purdie (8): lz4: Use the new branch naming from upstream Revert "bitbake.conf: Add all layers (from BBLAYERS) to PSEUDO_IGNORE_PATHS" build-appliance-image: Update to master head revision bitbake: Revert "fetch2: use relative symlinks for anything pulled from PREMIRRORS" build-appliance-image: Update to master head revision metadata_scm: Fix signature handling of METADATA_REVISION and METADATA_BRANCH poky: Set SDK_VERSION explicitly build-appliance-image: Update to master head revision Ross Burton (9): oeqa/devtool: use Yocto mirror for pv-1.5.3 tarball image_types: remove obsolete tar comment image_types: sort tarball file listings package_manager/ipk: neaten OPKGLIBDIR logic ldconfig-native: don't write auxiliary cache package_manager/ipk: improve remove_packaging_data oeqa/selftest/containerimage: update for improved cleanup coreutils: add SUSE-specific issues to CVE whitelist bitbake: msg: use safe YAML loader Sinan Kaya (1): poky-tiny: enable section removal Tomasz Dziendzielski (1): pseudo: Update to print PSEUDO_LOGFILE in abort message on path mismatches sangeeta jain (1): meta/lib/oeqa/manual/oe-core.json: Update test_bitbake_devshell zangrc (3): libinput: upgrade 1.16.3 -> 1.16.4 lighttpd: upgrade 1.4.55 -> 1.4.56 sysstat: upgrade 12.4.0 -> 12.4.1 Signed-off-by: Andrew Geissler <geissonator@yahoo.com> Change-Id: I65f2f1c9d44433f3e62609240012c42256679b51
Diffstat (limited to 'poky/documentation/ref-manual/images.rst')
-rw-r--r--poky/documentation/ref-manual/images.rst138
1 files changed, 138 insertions, 0 deletions
diff --git a/poky/documentation/ref-manual/images.rst b/poky/documentation/ref-manual/images.rst
new file mode 100644
index 000000000..5e9374eae
--- /dev/null
+++ b/poky/documentation/ref-manual/images.rst
@@ -0,0 +1,138 @@
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+******
+Images
+******
+
+The OpenEmbedded build system provides several example images to satisfy
+different needs. When you issue the ``bitbake`` command you provide a
+"top-level" recipe that essentially begins the build for the type of
+image you want.
+
+.. note::
+
+ Building an image without GNU General Public License Version 3
+ (GPLv3), GNU Lesser General Public License Version 3 (LGPLv3), and
+ the GNU Affero General Public License Version 3 (AGPL-3.0) components
+ is only supported for minimal and base images. Furthermore, if you
+ are going to build an image using non-GPLv3 and similarly licensed
+ components, you must make the following changes in the ``local.conf``
+ file before using the BitBake command to build the minimal or base
+ image:
+ ::
+
+ 1. Comment out the EXTRA_IMAGE_FEATURES line
+ 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0"
+
+
+From within the ``poky`` Git repository, you can use the following
+command to display the list of directories within the :term:`Source Directory`
+that contain image recipe files: ::
+
+ $ ls meta*/recipes*/images/*.bb
+
+Following is a list of supported recipes:
+
+- ``build-appliance-image``: An example virtual machine that contains
+ all the pieces required to run builds using the build system as well
+ as the build system itself. You can boot and run the image using
+ either the `VMware
+ Player <http://www.vmware.com/products/player/overview.html>`__ or
+ `VMware
+ Workstation <http://www.vmware.com/products/workstation/overview.html>`__.
+ For more information on this image, see the :yocto_home:`Build
+ Appliance </software-item/build-appliance>` page
+ on the Yocto Project website.
+
+- ``core-image-base``: A console-only image that fully supports the
+ target device hardware.
+
+- ``core-image-clutter``: An image with support for the Open GL-based
+ toolkit Clutter, which enables development of rich and animated
+ graphical user interfaces.
+
+- ``core-image-full-cmdline``: A console-only image with more
+ full-featured Linux system functionality installed.
+
+- ``core-image-lsb``: An image that conforms to the Linux Standard Base
+ (LSB) specification. This image requires a distribution configuration
+ that enables LSB compliance (e.g. ``poky-lsb``). If you build
+ ``core-image-lsb`` without that configuration, the image will not be
+ LSB-compliant.
+
+- ``core-image-lsb-dev``: A ``core-image-lsb`` image that is suitable
+ for development work using the host. The image includes headers and
+ libraries you can use in a host development environment. This image
+ requires a distribution configuration that enables LSB compliance
+ (e.g. ``poky-lsb``). If you build ``core-image-lsb-dev`` without that
+ configuration, the image will not be LSB-compliant.
+
+- ``core-image-lsb-sdk``: A ``core-image-lsb`` that includes everything
+ in the cross-toolchain but also includes development headers and
+ libraries to form a complete standalone SDK. This image requires a
+ distribution configuration that enables LSB compliance (e.g.
+ ``poky-lsb``). If you build ``core-image-lsb-sdk`` without that
+ configuration, the image will not be LSB-compliant. This image is
+ suitable for development using the target.
+
+- ``core-image-minimal``: A small image just capable of allowing a
+ device to boot.
+
+- ``core-image-minimal-dev``: A ``core-image-minimal`` image suitable
+ for development work using the host. The image includes headers and
+ libraries you can use in a host development environment.
+
+- ``core-image-minimal-initramfs``: A ``core-image-minimal`` image that
+ has the Minimal RAM-based Initial Root Filesystem (initramfs) as part
+ of the kernel, which allows the system to find the first "init"
+ program more efficiently. See the
+ :term:`PACKAGE_INSTALL` variable for
+ additional information helpful when working with initramfs images.
+
+- ``core-image-minimal-mtdutils``: A ``core-image-minimal`` image that
+ has support for the Minimal MTD Utilities, which let the user
+ interact with the MTD subsystem in the kernel to perform operations
+ on flash devices.
+
+- ``core-image-rt``: A ``core-image-minimal`` image plus a real-time
+ test suite and tools appropriate for real-time use.
+
+- ``core-image-rt-sdk``: A ``core-image-rt`` image that includes
+ everything in the cross-toolchain. The image also includes
+ development headers and libraries to form a complete stand-alone SDK
+ and is suitable for development using the target.
+
+- ``core-image-sato``: An image with Sato support, a mobile environment
+ and visual style that works well with mobile devices. The image
+ supports X11 with a Sato theme and applications such as a terminal,
+ editor, file manager, media player, and so forth.
+
+- ``core-image-sato-dev``: A ``core-image-sato`` image suitable for
+ development using the host. The image includes libraries needed to
+ build applications on the device itself, testing and profiling tools,
+ and debug symbols. This image was formerly ``core-image-sdk``.
+
+- ``core-image-sato-sdk``: A ``core-image-sato`` image that includes
+ everything in the cross-toolchain. The image also includes
+ development headers and libraries to form a complete standalone SDK
+ and is suitable for development using the target.
+
+- ``core-image-testmaster``: A "master" image designed to be used for
+ automated runtime testing. Provides a "known good" image that is
+ deployed to a separate partition so that you can boot into it and use
+ it to deploy a second image to be tested. You can find more
+ information about runtime testing in the
+ ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
+ section in the Yocto Project Development Tasks Manual.
+
+- ``core-image-testmaster-initramfs``: A RAM-based Initial Root
+ Filesystem (initramfs) image tailored for use with the
+ ``core-image-testmaster`` image.
+
+- ``core-image-weston``: A very basic Wayland image with a terminal.
+ This image provides the Wayland protocol libraries and the reference
+ Weston compositor. For more information, see the
+ ":ref:`dev-manual/common-tasks:using wayland and weston`"
+ section in the Yocto Project Development Tasks Manual.
+
+- ``core-image-x11``: A very basic X11 image with a terminal.