summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/features.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/features.rst')
-rw-r--r--documentation/ref-manual/features.rst22
1 files changed, 11 insertions, 11 deletions
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index 31d24b8c28..ded653221c 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -10,10 +10,10 @@ can select, and a reference on feature backfilling.
10 10
11Features provide a mechanism for working out which packages should be 11Features provide a mechanism for working out which packages should be
12included in the generated images. Distributions can select which 12included in the generated images. Distributions can select which
13features they want to support through the ``DISTRO_FEATURES`` variable, 13features they want to support through the :term:`DISTRO_FEATURES` variable,
14which is set or appended to in a distribution's configuration file such 14which is set or appended to in a distribution's configuration file such
15as ``poky.conf``, ``poky-tiny.conf``, ``poky-lsb.conf`` and so forth. 15as ``poky.conf``, ``poky-tiny.conf``, ``poky-lsb.conf`` and so forth.
16Machine features are set in the ``MACHINE_FEATURES`` variable, which is 16Machine features are set in the :term:`MACHINE_FEATURES` variable, which is
17set in the machine configuration file and specifies the hardware 17set in the machine configuration file and specifies the hardware
18features for a given machine. 18features for a given machine.
19 19
@@ -267,7 +267,7 @@ these valid features is as follows:
267- *ssh-server-openssh:* Installs the OpenSSH SSH server, which is more 267- *ssh-server-openssh:* Installs the OpenSSH SSH server, which is more
268 full-featured than Dropbear. Note that if both the OpenSSH SSH server 268 full-featured than Dropbear. Note that if both the OpenSSH SSH server
269 and the Dropbear minimal SSH server are present in 269 and the Dropbear minimal SSH server are present in
270 ``IMAGE_FEATURES``, then OpenSSH will take precedence and Dropbear 270 :term:`IMAGE_FEATURES`, then OpenSSH will take precedence and Dropbear
271 will not be installed. 271 will not be installed.
272 272
273- *tools-debug:* Installs debugging tools such as ``strace`` and 273- *tools-debug:* Installs debugging tools such as ``strace`` and
@@ -323,27 +323,27 @@ Here are two examples to help illustrate feature backfilling:
323- *The "pulseaudio" distro feature option*: Previously, PulseAudio 323- *The "pulseaudio" distro feature option*: Previously, PulseAudio
324 support was enabled within the Qt and GStreamer frameworks. Because 324 support was enabled within the Qt and GStreamer frameworks. Because
325 of this, the feature is backfilled and thus enabled for all distros 325 of this, the feature is backfilled and thus enabled for all distros
326 through the ``DISTRO_FEATURES_BACKFILL`` variable in the 326 through the :term:`DISTRO_FEATURES_BACKFILL` variable in the
327 ``meta/conf/bitbake.conf`` file. However, your distro needs to 327 ``meta/conf/bitbake.conf`` file. However, your distro needs to
328 disable the feature. You can disable the feature without affecting 328 disable the feature. You can disable the feature without affecting
329 other existing distro configurations that need PulseAudio support by 329 other existing distro configurations that need PulseAudio support by
330 adding "pulseaudio" to ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` in 330 adding "pulseaudio" to :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` in
331 your distro's ``.conf`` file. Adding the feature to this variable 331 your distro's ``.conf`` file. Adding the feature to this variable
332 when it also exists in the ``DISTRO_FEATURES_BACKFILL`` variable 332 when it also exists in the :term:`DISTRO_FEATURES_BACKFILL` variable
333 prevents the build system from adding the feature to your 333 prevents the build system from adding the feature to your
334 configuration's ``DISTRO_FEATURES``, effectively disabling the 334 configuration's :term:`DISTRO_FEATURES`, effectively disabling the
335 feature for that particular distro. 335 feature for that particular distro.
336 336
337- *The "rtc" machine feature option*: Previously, real time clock (RTC) 337- *The "rtc" machine feature option*: Previously, real time clock (RTC)
338 support was enabled for all target devices. Because of this, the 338 support was enabled for all target devices. Because of this, the
339 feature is backfilled and thus enabled for all machines through the 339 feature is backfilled and thus enabled for all machines through the
340 ``MACHINE_FEATURES_BACKFILL`` variable in the 340 :term:`MACHINE_FEATURES_BACKFILL` variable in the
341 ``meta/conf/bitbake.conf`` file. However, your target device does not 341 ``meta/conf/bitbake.conf`` file. However, your target device does not
342 have this capability. You can disable RTC support for your device 342 have this capability. You can disable RTC support for your device
343 without affecting other machines that need RTC support by adding the 343 without affecting other machines that need RTC support by adding the
344 feature to your machine's ``MACHINE_FEATURES_BACKFILL_CONSIDERED`` 344 feature to your machine's :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
345 list in the machine's ``.conf`` file. Adding the feature to this 345 list in the machine's ``.conf`` file. Adding the feature to this
346 variable when it also exists in the ``MACHINE_FEATURES_BACKFILL`` 346 variable when it also exists in the :term:`MACHINE_FEATURES_BACKFILL`
347 variable prevents the build system from adding the feature to your 347 variable prevents the build system from adding the feature to your
348 configuration's ``MACHINE_FEATURES``, effectively disabling RTC 348 configuration's :term:`MACHINE_FEATURES`, effectively disabling RTC
349 support for that particular machine. 349 support for that particular machine.