summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-09-21 21:35:12 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-09-24 17:44:56 +0100
commitec447505b238bbd42e6e14334fa57f46ba8fc35c (patch)
tree49cedda169f06ba55bd0c7c1ec695747c58e553a
parent6a6a67b5726f6b12a175a2c16a3a7a0a13b01c54 (diff)
downloadpoky-ec447505b238bbd42e6e14334fa57f46ba8fc35c.tar.gz
ref-manual: features.rst: add missing default distro features
Document default machine features defined in Poky, and which were not listed in the documentation yet. Took the values of DISTRO_FEATURES_DEFAULT and POKY_DEFAULT_DISTRO_FEATURES: meta-poky/conf/distro/poky.conf:DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${POKY_DEFAULT_DISTRO_FEATURES}" Also explain that extra layers can define their own features. This addresses [YOCTO #14515] Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/features.rst43
1 files changed, 40 insertions, 3 deletions
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index 8dfe29d66a..5e853caa2c 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -113,10 +113,15 @@ configuration level. See the
113information. 113information.
114 114
115This list only represents features as shipped with the Yocto Project 115This list only represents features as shipped with the Yocto Project
116metadata: 116metadata, as extra layers can define their own:
117 117
118- *alsa:* Include ALSA support (OSS compatibility kernel modules 118- *3g:* Include support for cellular data.
119 installed if available). 119
120- *acl:* Include
121 `Access Control List <https://en.wikipedia.org/wiki/Access-control_list>`__ support.
122
123- *alsa:* Include `Advanced Linux Sound Architecture <https://en.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture>`__
124 support (OSS compatibility kernel modules installed if available).
120 125
121- *api-documentation:* Enables generation of API documentation during 126- *api-documentation:* Enables generation of API documentation during
122 recipe builds. The resulting documentation is added to SDK tarballs 127 recipe builds. The resulting documentation is added to SDK tarballs
@@ -129,6 +134,10 @@ metadata:
129 134
130- *cramfs:* Include CramFS support. 135- *cramfs:* Include CramFS support.
131 136
137- *debuginfod:* Include support for getting ELF debugging information through
138 a :ref:`debuginfod <dev-manual/common-tasks:using the debuginfod server method>`
139 server.
140
132- *directfb:* Include DirectFB support. 141- *directfb:* Include DirectFB support.
133 142
134- *ext2:* Include tools for supporting for devices with internal 143- *ext2:* Include tools for supporting for devices with internal
@@ -136,14 +145,25 @@ metadata:
136 145
137- *ipsec:* Include IPSec support. 146- *ipsec:* Include IPSec support.
138 147
148- *ipv4:* Include IPv4 support.
149
139- *ipv6:* Include IPv6 support. 150- *ipv6:* Include IPv6 support.
140 151
141- *keyboard:* Include keyboard support (e.g. keymaps will be loaded 152- *keyboard:* Include keyboard support (e.g. keymaps will be loaded
142 during boot). 153 during boot).
143 154
155- *largefile:* Enable building applications with
156 `argefile support <https://en.wikipedia.org/wiki/Large-file_support>`__.
157
158- *multiarch:* Enable building applications with multiple architecture
159 support.
160
144- *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the 161- *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the
145 target. 162 target.
146 163
164- *nfc:* Include support for
165 `Near Field Communication <https://en.wikipedia.org/wiki/Near-field_communication>`__.
166
147- *nfs:* Include NFS client support (for mounting NFS exports on 167- *nfs:* Include NFS client support (for mounting NFS exports on
148 device). 168 device).
149 169
@@ -162,6 +182,11 @@ metadata:
162 ":ref:`dev-manual/common-tasks:testing packages with ptest`" section 182 ":ref:`dev-manual/common-tasks:testing packages with ptest`" section
163 in the Yocto Project Development Tasks Manual. 183 in the Yocto Project Development Tasks Manual.
164 184
185- *seccomp:* Enables building applications with
186 `seccomp <https://en.wikipedia.org/wiki/Seccomp>`__ support, to
187 allow them to strictly restrict the system calls that they are allowed
188 to invoke.
189
165- *smbfs:* Include SMB networks client support (for mounting 190- *smbfs:* Include SMB networks client support (for mounting
166 Samba/Microsoft Windows shares on device). 191 Samba/Microsoft Windows shares on device).
167 192
@@ -180,6 +205,12 @@ metadata:
180 directories into their respective counterparts in the ``/usr`` 205 directories into their respective counterparts in the ``/usr``
181 directory to provide better package and application compatibility. 206 directory to provide better package and application compatibility.
182 207
208- *vfat:* Include `FAT filesystem <https://en.wikipedia.org/wiki/File_Allocation_Table>`__
209 support.
210
211- *vulkan:* Include support for the
212 `Vulkan API <https://en.wikipedia.org/wiki/Vulkan>`__.
213
183- *wayland:* Include the Wayland display server protocol and the 214- *wayland:* Include the Wayland display server protocol and the
184 library that supports it. 215 library that supports it.
185 216
@@ -187,6 +218,12 @@ metadata:
187 218
188- *x11:* Include the X server and libraries. 219- *x11:* Include the X server and libraries.
189 220
221- *xattr:* Include support for
222 `extended file attributes <https://en.wikipedia.org/wiki/Extended_file_attributes>`__.
223
224- *zeroconf:* Include support for
225 `zero configuration networking <https://en.wikipedia.org/wiki/Zero-configuration_networking>`__.
226
190.. _ref-features-image: 227.. _ref-features-image:
191 228
192Image Features 229Image Features