diff options
| -rw-r--r-- | documentation/ref-manual/features.rst | 50 |
1 files changed, 50 insertions, 0 deletions
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: | |||
| 72 | 72 | ||
| 73 | - *phone:* Mobile phone (voice) support | 73 | - *phone:* Mobile phone (voice) support |
| 74 | 74 | ||
| 75 | - *qemu-usermode:* QEMU can support user-mode emulation for this machine | ||
| 76 | |||
| 75 | - *qvga:* Machine has a QVGA (320x240) display | 77 | - *qvga:* Machine has a QVGA (320x240) display |
| 76 | 78 | ||
| 77 | - *rtc:* Machine has a Real-Time Clock | 79 | - *rtc:* Machine has a Real-Time Clock |
| @@ -112,6 +114,13 @@ configuration level. See the | |||
| 112 | :term:`COMBINED_FEATURES` variable for more | 114 | :term:`COMBINED_FEATURES` variable for more |
| 113 | information. | 115 | information. |
| 114 | 116 | ||
| 117 | .. note:: | ||
| 118 | |||
| 119 | :term:`DISTRO_FEATURES` is normally independent of kernel configuration, | ||
| 120 | so if a feature specified in :term:`DISTRO_FEATURES` also relies on | ||
| 121 | support in the kernel, you will also need to ensure that support is | ||
| 122 | enabled in the kernel configuration. | ||
| 123 | |||
| 115 | This list only represents features as shipped with the Yocto Project | 124 | This list only represents features as shipped with the Yocto Project |
| 116 | metadata, as extra layers can define their own: | 125 | metadata, as extra layers can define their own: |
| 117 | 126 | ||
| @@ -143,6 +152,9 @@ metadata, as extra layers can define their own: | |||
| 143 | - *ext2:* Include tools for supporting for devices with internal | 152 | - *ext2:* Include tools for supporting for devices with internal |
| 144 | HDD/Microdrive for storing files (instead of Flash only devices). | 153 | HDD/Microdrive for storing files (instead of Flash only devices). |
| 145 | 154 | ||
| 155 | - *gobject-introspection-data:* Include data to support | ||
| 156 | `GObject Introspection <https://gi.readthedocs.io/en/latest/>`__. | ||
| 157 | |||
| 146 | - *ipsec:* Include IPSec support. | 158 | - *ipsec:* Include IPSec support. |
| 147 | 159 | ||
| 148 | - *ipv4:* Include IPv4 support. | 160 | - *ipv4:* Include IPv4 support. |
| @@ -155,23 +167,38 @@ metadata, as extra layers can define their own: | |||
| 155 | - *multiarch:* Enable building applications with multiple architecture | 167 | - *multiarch:* Enable building applications with multiple architecture |
| 156 | support. | 168 | support. |
| 157 | 169 | ||
| 170 | - *ld-is-gold:* Use the `gold <https://en.wikipedia.org/wiki/Gold_(linker)>`__ | ||
| 171 | linker instead of the standard GCC linker (bfd). | ||
| 172 | |||
| 158 | - *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the | 173 | - *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the |
| 159 | target. | 174 | target. |
| 160 | 175 | ||
| 176 | - *lto:* Enable `Link-Time Optimisation <https://gcc.gnu.org/wiki/LinkTimeOptimization>`__. | ||
| 177 | |||
| 161 | - *nfc:* Include support for | 178 | - *nfc:* Include support for |
| 162 | `Near Field Communication <https://en.wikipedia.org/wiki/Near-field_communication>`__. | 179 | `Near Field Communication <https://en.wikipedia.org/wiki/Near-field_communication>`__. |
| 163 | 180 | ||
| 164 | - *nfs:* Include NFS client support (for mounting NFS exports on | 181 | - *nfs:* Include NFS client support (for mounting NFS exports on |
| 165 | device). | 182 | device). |
| 166 | 183 | ||
| 184 | - *nls:* Include National Language Support (NLS). | ||
| 185 | |||
| 167 | - *opengl:* Include the Open Graphics Library, which is a | 186 | - *opengl:* Include the Open Graphics Library, which is a |
| 168 | cross-language, multi-platform application programming interface used | 187 | cross-language, multi-platform application programming interface used |
| 169 | for rendering two and three-dimensional graphics. | 188 | for rendering two and three-dimensional graphics. |
| 170 | 189 | ||
| 190 | - *overlayfs:* Include `OverlayFS <https://docs.kernel.org/filesystems/overlayfs.html>`__ | ||
| 191 | support. | ||
| 192 | |||
| 193 | - *pam:* Include `Pluggable Authentication Module (PAM) <https://en.wikipedia.org/wiki/Pluggable_authentication_module>`__ | ||
| 194 | support. | ||
| 195 | |||
| 171 | - *pci:* Include PCI bus support. | 196 | - *pci:* Include PCI bus support. |
| 172 | 197 | ||
| 173 | - *pcmcia:* Include PCMCIA/CompactFlash support. | 198 | - *pcmcia:* Include PCMCIA/CompactFlash support. |
| 174 | 199 | ||
| 200 | - *polkit:* Include `Polkit <https://en.wikipedia.org/wiki/Polkit>`__ support. | ||
| 201 | |||
| 175 | - *ppp:* Include PPP dialup support. | 202 | - *ppp:* Include PPP dialup support. |
| 176 | 203 | ||
| 177 | - *ptest:* Enables building the package tests where supported by | 204 | - *ptest:* Enables building the package tests where supported by |
| @@ -179,6 +206,13 @@ metadata, as extra layers can define their own: | |||
| 179 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" section | 206 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" section |
| 180 | in the Yocto Project Development Tasks Manual. | 207 | in the Yocto Project Development Tasks Manual. |
| 181 | 208 | ||
| 209 | - *pulseaudio:* Include support for | ||
| 210 | `PulseAudio <https://www.freedesktop.org/wiki/Software/PulseAudio/>`__. | ||
| 211 | |||
| 212 | - *selinux:* Include support for | ||
| 213 | `Security-Enhanced Linux (SELinux) <https://en.wikipedia.org/wiki/Security-Enhanced_Linux>`__ | ||
| 214 | (requires `meta-selinux <https://layers.openembedded.org/layerindex/layer/meta-selinux/>`__). | ||
| 215 | |||
| 182 | - *seccomp:* Enables building applications with | 216 | - *seccomp:* Enables building applications with |
| 183 | `seccomp <https://en.wikipedia.org/wiki/Seccomp>`__ support, to | 217 | `seccomp <https://en.wikipedia.org/wiki/Seccomp>`__ support, to |
| 184 | allow them to strictly restrict the system calls that they are allowed | 218 | 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: | |||
| 270 | just disables the mechanism which forces an non-empty password for the | 304 | just disables the mechanism which forces an non-empty password for the |
| 271 | root user. | 305 | root user. |
| 272 | 306 | ||
| 307 | - *lic-pkgs:* Installs license packages for all packages installed in a | ||
| 308 | given image. | ||
| 309 | |||
| 273 | - *overlayfs-etc:* Configures the ``/etc`` directory to be in ``overlayfs``. | 310 | - *overlayfs-etc:* Configures the ``/etc`` directory to be in ``overlayfs``. |
| 274 | This allows to store device specific information elsewhere, especially | 311 | This allows to store device specific information elsewhere, especially |
| 275 | if the root filesystem is configured to be read-only. | 312 | if the root filesystem is configured to be read-only. |
| @@ -294,6 +331,12 @@ Here are the image features available for all images: | |||
| 294 | section in the Yocto Project Development Tasks Manual for more | 331 | section in the Yocto Project Development Tasks Manual for more |
| 295 | information. | 332 | information. |
| 296 | 333 | ||
| 334 | - *read-only-rootfs-delayed-postinsts:* when specified in conjunction | ||
| 335 | with ``read-only-rootfs``, specifies that post-install scripts are | ||
| 336 | still permitted (this assumes that the root filesystem will be made | ||
| 337 | writeable for the first boot; this feature does not do anything to | ||
| 338 | ensure that - it just disables the check for post-install scripts.) | ||
| 339 | |||
| 297 | - *splash:* Enables showing a splash screen during boot. By default, | 340 | - *splash:* Enables showing a splash screen during boot. By default, |
| 298 | this screen is provided by ``psplash``, which does allow | 341 | this screen is provided by ``psplash``, which does allow |
| 299 | customization. If you prefer to use an alternative splash screen | 342 | customization. If you prefer to use an alternative splash screen |
| @@ -301,6 +344,11 @@ Here are the image features available for all images: | |||
| 301 | different package name (or names) within the image recipe or at the | 344 | different package name (or names) within the image recipe or at the |
| 302 | distro configuration level. | 345 | distro configuration level. |
| 303 | 346 | ||
| 347 | - *stateless-rootfs:*: specifies that the image should be created as | ||
| 348 | stateless - when using ``systemd``, ``systemctl-native`` will not | ||
| 349 | be run on the image, leaving the image for population at runtime by | ||
| 350 | systemd. | ||
| 351 | |||
| 304 | - *staticdev-pkgs:* Installs static development packages, which are | 352 | - *staticdev-pkgs:* Installs static development packages, which are |
| 305 | static libraries (i.e. ``*.a`` files), for all packages installed in | 353 | static libraries (i.e. ``*.a`` files), for all packages installed in |
| 306 | a given image. | 354 | a given image. |
| @@ -351,6 +399,8 @@ these valid features is as follows: | |||
| 351 | - *tools-testapps:* Installs device testing tools (e.g. touchscreen | 399 | - *tools-testapps:* Installs device testing tools (e.g. touchscreen |
| 352 | debugging). | 400 | debugging). |
| 353 | 401 | ||
| 402 | - *weston:* Installs Weston (reference Wayland environment). | ||
| 403 | |||
| 354 | - *x11:* Installs the X server. | 404 | - *x11:* Installs the X server. |
| 355 | 405 | ||
| 356 | - *x11-base:* Installs the X server with a minimal environment. | 406 | - *x11-base:* Installs the X server with a minimal environment. |
