diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index dad871d516..ea4d257f2b 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst @@ -72,6 +72,8 @@ Project metadata: - *phone:* Mobile phone (voice) support +- *qemu-usermode:* QEMU can support user-mode emulation for this machine + - *qvga:* Machine has a QVGA (320x240) display - *rtc:* Machine has a Real-Time Clock @@ -112,6 +114,13 @@ configuration level. See the :term:`COMBINED_FEATURES` variable for more information. +.. note:: + + :term:`DISTRO_FEATURES` is normally independent of kernel configuration, + so if a feature specified in :term:`DISTRO_FEATURES` also relies on + support in the kernel, you will also need to ensure that support is + enabled in the kernel configuration. + This list only represents features as shipped with the Yocto Project metadata, as extra layers can define their own: @@ -143,6 +152,9 @@ metadata, as extra layers can define their own: - *ext2:* Include tools for supporting for devices with internal HDD/Microdrive for storing files (instead of Flash only devices). +- *gobject-introspection-data:* Include data to support + `GObject Introspection `__. + - *ipsec:* Include IPSec support. - *ipv4:* Include IPv4 support. @@ -155,23 +167,38 @@ metadata, as extra layers can define their own: - *multiarch:* Enable building applications with multiple architecture support. +- *ld-is-gold:* Use the `gold `__ + linker instead of the standard GCC linker (bfd). + - *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the target. +- *lto:* Enable `Link-Time Optimisation `__. + - *nfc:* Include support for `Near Field Communication `__. - *nfs:* Include NFS client support (for mounting NFS exports on device). +- *nls:* Include National Language Support (NLS). + - *opengl:* Include the Open Graphics Library, which is a cross-language, multi-platform application programming interface used for rendering two and three-dimensional graphics. +- *overlayfs:* Include `OverlayFS `__ + support. + +- *pam:* Include `Pluggable Authentication Module (PAM) `__ + support. + - *pci:* Include PCI bus support. - *pcmcia:* Include PCMCIA/CompactFlash support. +- *polkit:* Include `Polkit `__ support. + - *ppp:* Include PPP dialup support. - *ptest:* Enables building the package tests where supported by @@ -179,6 +206,13 @@ metadata, as extra layers can define their own: ":ref:`dev-manual/common-tasks:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. +- *pulseaudio:* Include support for + `PulseAudio `__. + +- *selinux:* Include support for + `Security-Enhanced Linux (SELinux) `__ + (requires `meta-selinux `__). + - *seccomp:* Enables building applications with `seccomp `__ support, to allow them to strictly restrict the system calls that they are allowed @@ -270,6 +304,9 @@ Here are the image features available for all images: just disables the mechanism which forces an non-empty password for the root user. +- *lic-pkgs:* Installs license packages for all packages installed in a + given image. + - *overlayfs-etc:* Configures the ``/etc`` directory to be in ``overlayfs``. This allows to store device specific information elsewhere, especially if the root filesystem is configured to be read-only. @@ -294,6 +331,12 @@ Here are the image features available for all images: section in the Yocto Project Development Tasks Manual for more information. +- *read-only-rootfs-delayed-postinsts:* when specified in conjunction + with ``read-only-rootfs``, specifies that post-install scripts are + still permitted (this assumes that the root filesystem will be made + writeable for the first boot; this feature does not do anything to + ensure that - it just disables the check for post-install scripts.) + - *splash:* Enables showing a splash screen during boot. By default, this screen is provided by ``psplash``, which does allow customization. If you prefer to use an alternative splash screen @@ -301,6 +344,11 @@ Here are the image features available for all images: different package name (or names) within the image recipe or at the distro configuration level. +- *stateless-rootfs:*: specifies that the image should be created as + stateless - when using ``systemd``, ``systemctl-native`` will not + be run on the image, leaving the image for population at runtime by + systemd. + - *staticdev-pkgs:* Installs static development packages, which are static libraries (i.e. ``*.a`` files), for all packages installed in a given image. @@ -351,6 +399,8 @@ these valid features is as follows: - *tools-testapps:* Installs device testing tools (e.g. touchscreen debugging). +- *weston:* Installs Weston (reference Wayland environment). + - *x11:* Installs the X server. - *x11-base:* Installs the X server with a minimal environment.