documentation/ref-manual/features.rst

1 .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
9 can select, and a reference on :ref:`ref-features-backfill`.
15 as ``poky.conf``, ``poky-tiny.conf``, ``poky-lsb.conf`` and so forth.
34 .. _ref-features-machine:
41 one-to-one correspondence to packages, and they can go beyond simply
45 specified within the :ref:`ref-tasks-configure` task
51 -  *acpi:* Hardware has ACPI (x86/x86_64 only)
53 -  *alsa:* Hardware has ALSA audio drivers
55 -  *bluetooth:* Hardware has integrated BT
57 -  *efi:* Support for booting through EFI
59 -  *ext2:* Hardware HDD or Microdrive
61 -  *keyboard:* Hardware has a keyboard
63 -  *numa:* Hardware has non-uniform memory access
65 -  *pcbios:* Support for booting through BIOS
67 -  *pci:* Hardware has a PCI bus
69 -  *pcmcia:* Hardware has PCMCIA or CompactFlash sockets
71 -  *phone:* Mobile phone (voice) support
73 -  *qemu-usermode:* QEMU can support user-mode emulation for this machine
75 -  *qvga:* Machine has a QVGA (320x240) display
77 -  *rtc:* Machine has a Real-Time Clock
79 -  *screen:* Hardware has a screen
81 -  *serial:* Hardware has serial support (usually RS232)
83 -  *touchscreen:* Hardware has a touchscreen
85 -  *usbgadget:* Hardware is USB gadget device capable
87 -  *usbhost:* Hardware is USB Host capable
89 -  *vfat:* FAT file system support
91 -  *wifi:* Hardware has integrated WiFi
93 .. _ref-features-distro:
100 your distribution. Features do not have a one-to-one correspondence to
104 script during the :ref:`ref-tasks-configure` task for
125 -  *3g:* Include support for cellular data.
127 -  *acl:* Include :wikipedia:`Access Control List <Access-control_list>` support.
129 -  *alsa:* Include :wikipedia:`Advanced Linux Sound Architecture <Advanced_Linux_Sound_Architecture…
132 -  *api-documentation:* Enables generation of API documentation during
134    when the ``bitbake -c populate_sdk`` command is used. See the
135    ":ref:`sdk-manual/appendix-customizing-standard:adding api documentation to the standard sdk`"
139 -  *bluetooth:* Include bluetooth support (integrated BT only).
141 -  *cramfs:* Include CramFS support.
143 -  *debuginfod:* Include support for getting ELF debugging information through
144    a :ref:`debuginfod <dev-manual/debugging:using the debuginfod server method>`
147 -  *directfb:* Include DirectFB support.
149 -  *ext2:* Include tools for supporting devices with internal
152 -  *gobject-introspection-data:* Include data to support
155 -  *ipsec:* Include IPSec support.
157 -  *ipv4:* Include IPv4 support.
159 -  *ipv6:* Include IPv6 support.
161 -  *keyboard:* Include keyboard support (e.g. keymaps will be loaded
164 -  *minidebuginfo:* Add minimal debug symbols :ref:`(minidebuginfo)<dev-manual/debugging:enabling m…
167 -  *multiarch:* Enable building applications with multiple architecture
170 -  *ld-is-gold:* Use the :wikipedia:`gold <Gold_(linker)>`
173 -  *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the
176 -  *lto:* Enable `Link-Time Optimisation <https://gcc.gnu.org/wiki/LinkTimeOptimization>`__.
178 -  *nfc:* Include support for
179    `Near Field Communication <https://en.wikipedia.org/wiki/Near-field_communication>`__.
181 -  *nfs:* Include NFS client support (for mounting NFS exports on
184 -  *nls:* Include National Language Support (NLS).
186 -  *opengl:* Include the Open Graphics Library, which is a
187    cross-language, multi-platform application programming interface used
188    for rendering two and three-dimensional graphics.
190 -  *overlayfs:* Include `OverlayFS <https://docs.kernel.org/filesystems/overlayfs.html>`__
193 -  *pam:* Include :wikipedia:`Pluggable Authentication Module (PAM) <Pluggable_authentication_modul…
196 -  *pci:* Include PCI bus support.
198 -  *pcmcia:* Include PCMCIA/CompactFlash support.
200 -  *pni-names:* Enable generation of persistent network interface names, i.e.
204 -  *polkit:* Include :wikipedia:`Polkit <Polkit>` support.
206 -  *ppp:* Include PPP dialup support.
208 -  *ptest:* Enables building the package tests where supported by
210    ":ref:`dev-manual/packages:testing packages with ptest`" section
213 -  *pulseaudio:* Include support for
216 -  *selinux:* Include support for
217    :wikipedia:`Security-Enhanced Linux (SELinux) <Security-Enhanced_Linux>`
218    (requires `meta-selinux <https://layers.openembedded.org/layerindex/layer/meta-selinux/>`__).
220 -  *seccomp:* Enables building applications with
221    :wikipedia:`seccomp <Seccomp>` support, to
225 -  *smbfs:* Include SMB networks client support (for mounting
228 -  *systemd:* Include support for this ``init`` manager, which is a full
233 -  *systemd-resolved:* Include support and use ``systemd-resolved`` as the
237 -  *usbgadget:* Include USB Gadget Device support (for USB
240 -  *usbhost:* Include USB Host support (allows to connect external
243 -  *usrmerge:* Merges the ``/bin``, ``/sbin``, ``/lib``, and ``/lib64``
247 -  *vfat:* Include :wikipedia:`FAT filesystem <File_Allocation_Table>`
250 -  *vulkan:* Include support for the :wikipedia:`Vulkan API <Vulkan>`.
252 -  *wayland:* Include the Wayland display server protocol and the
255 -  *wifi:* Include WiFi support (integrated only).
257 -  *x11:* Include the X server and libraries.
259 -  *xattr:* Include support for
262 -  *zeroconf:* Include support for
263    `zero configuration networking <https://en.wikipedia.org/wiki/Zero-configuration_networking>`__.
265 .. _ref-features-image:
280 -  *allow-empty-password:* Allows Dropbear and OpenSSH to accept
283 -  *allow-root-login:* Allows Dropbear and OpenSSH to accept root logins.
285 -  *dbg-pkgs:* Installs debug symbol packages for all packages installed
288 -  *debug-tweaks:* Makes an image suitable for development (e.g. allows
289    root logins, logins without passwords ---including root ones, and enables
290    post-installation logging). See the ``allow-empty-password``,
291    ``allow-root-login``, ``empty-root-password``, and ``post-install-logging``
294 -  *dev-pkgs:* Installs development packages (headers and extra library
297 -  *doc-pkgs:* Installs documentation packages for all packages
300 -  *empty-root-password:* This feature or ``debug-tweaks`` is required if
302    are not present in :term:`IMAGE_FEATURES`, a non-empty password is
306        ``empty-root-password`` doesn't set an empty root password by itself.
308        :oe_git:`base-passwd </openembedded-core/tree/meta/recipes-core/base-passwd/>`
309        and :oe_git:`shadow </openembedded-core/tree/meta/recipes-extended/shadow/>`
310        recipes, and the presence of ``empty-root-password`` or ``debug-tweaks``
311        just disables the mechanism which forces an non-empty password for the
314 -  *lic-pkgs:* Installs license packages for all packages installed in a
317 -  *overlayfs-etc:* Configures the ``/etc`` directory to be in ``overlayfs``.
319    if the root filesystem is configured to be read-only.
321 -  *package-management:* Installs package management tools and preserves
324 -  *post-install-logging:* Enables logging postinstall script runs to
331       ``files/fs-perms-volatile-log.txt`` value from
334 -  *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes.
336 -  *read-only-rootfs:* Creates an image whose root filesystem is
337    read-only. See the
338    ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`"
342 -  *read-only-rootfs-delayed-postinsts:* when specified in conjunction
343    with ``read-only-rootfs``, specifies that post-install scripts are
346    ensure that - it just disables the check for post-install scripts.)
348 -  *serial-autologin-root:* when specified in conjunction with
349    ``empty-root-password`` will automatically login as root on the
354 -  *splash:* Enables showing a splash screen during boot. By default,
361 -  *stateless-rootfs:*: specifies that the image should be created as
362    stateless - when using ``systemd``, ``systemctl-native`` will not
366 -  *staticdev-pkgs:* Installs static development packages, which are
371 :ref:`ref-classes-core-image` class. The current list of
374 -  *hwcodecs:* Installs hardware acceleration codecs.
376 -  *nfs-server:* Installs an NFS server.
378 -  *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and
379    ``LTTng``. For general information on user-space tools, see the
380    :doc:`/sdk-manual/index` manual.
382 -  *ssh-server-dropbear:* Installs the Dropbear minimal SSH server.
386       As of the 4.1 release, the ``ssh-server-dropbear`` feature also
387       recommends the ``openssh-sftp-server`` package, which by default
392       installed, you can either remove ``ssh-server-dropbear`` from
397          BAD_RECOMMENDATIONS += "openssh-sftp-server"
399 -  *ssh-server-openssh:* Installs the OpenSSH SSH server, which is more
400    full-featured than Dropbear. Note that if both the OpenSSH SSH server
405 -  *tools-debug:* Installs debugging tools such as ``strace`` and
407    ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" section
409    tracing and profiling, see the :doc:`/profile-manual/index`.
411 -  *tools-sdk:* Installs a full SDK that runs on the device.
413 -  *tools-testapps:* Installs device testing tools (e.g. touchscreen
416 -  *weston:* Installs Weston (reference Wayland environment).
418 -  *x11:* Installs the X server.
420 -  *x11-base:* Installs the X server with a minimal environment.
422 -  *x11-sato:* Installs the OpenedHand Sato environment.
424 .. _ref-features-backfill:
451 -  *The "pulseaudio" distro feature option*: Previously, PulseAudio support was
455    file. However, if your distro needs to disable the feature, you can do so
464 -  *The "rtc" machine feature option*: Previously, real time clock (RTC)
469    disable RTC support for your device without affecting other machines