diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-11-20 10:36:05 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:53:15 +0000 |
commit | 89fc8b84b70ab3bc97516f79833b7e3845c1f9d8 (patch) | |
tree | 8379adce339786e9df19cefd4e79ce13c1183c9a /documentation/ref-manual/ref-variables.xml | |
parent | b2d0ff180d161579c5a2a6edb7f6eb0da6cb9559 (diff) | |
download | poky-89fc8b84b70ab3bc97516f79833b7e3845c1f9d8.tar.gz |
ref-manual: Updated to *_FEATURES variables.
I updated the MACHINE_FEATURES, DISTRO_FEATURES, and
COMBINED_FEATURES variable descriptions to better reflect what
they actually do. Also, fixed two occurences of IrDA in the
features lists section.
(From yocto-docs rev: af79b0b3bc88ca0811d488c7c5d6b5407de808a7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 71 |
1 files changed, 53 insertions, 18 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 43898e158c..cb8d9a5b39 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -917,10 +917,27 @@ | |||
917 | 917 | ||
918 | <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm> | 918 | <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm> |
919 | <glossdef> | 919 | <glossdef> |
920 | <para>A set of features common between | 920 | <para> |
921 | Provides a list of hardware features that are enabled in | ||
922 | both | ||
921 | <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> | 923 | <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> |
922 | and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. | 924 | and |
923 | See the glossary descriptions for these variables for more information.</para> | 925 | <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. |
926 | This select list of features is a list features that make | ||
927 | sense to be controlled both at the machine and distribution | ||
928 | configuration level. | ||
929 | For example, the "bluetooth" feature requires hardware | ||
930 | support but should also be optional at the distribution | ||
931 | level, in case the hardware supports Bluetooth but you | ||
932 | do not ever intend to use it. | ||
933 | </para> | ||
934 | |||
935 | <para> | ||
936 | For more information, see the | ||
937 | <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> | ||
938 | and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> | ||
939 | variables. | ||
940 | </para> | ||
924 | </glossdef> | 941 | </glossdef> |
925 | </glossentry> | 942 | </glossentry> |
926 | 943 | ||
@@ -1306,10 +1323,25 @@ | |||
1306 | 1323 | ||
1307 | <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm> | 1324 | <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm> |
1308 | <glossdef> | 1325 | <glossdef> |
1309 | <para>The features enabled for the distribution. | 1326 | <para> |
1310 | For a list of supported features that ship with the | 1327 | The software support you want in your distribution for |
1311 | Yocto Project, see the | 1328 | various features. |
1312 | "<link linkend='ref-features-distro'>Distro</link>" | 1329 | In most cases, the presence or absence of a feature in |
1330 | <filename>DISTRO_FEATURES</filename> is translated to the | ||
1331 | appropriate option supplied to the configure script | ||
1332 | during <filename>do_configure</filename> for recipes that | ||
1333 | optionally support the feature. | ||
1334 | For example, specifying x11 in | ||
1335 | <filename>DISTRO_FEATURES</filename>, causes | ||
1336 | every piece of software built for the target that can | ||
1337 | optionally support X11 to have its X11 support enabled. | ||
1338 | </para> | ||
1339 | |||
1340 | <para> | ||
1341 | Two more examples are Bluetooth and NFS support. | ||
1342 | For a more complete features that ship with the Yocto | ||
1343 | Project that you can provide using this variable, see the | ||
1344 | "<link linkend='ref-features-distro'>Distro Features</link>" | ||
1313 | section. | 1345 | section. |
1314 | </para> | 1346 | </para> |
1315 | </glossdef> | 1347 | </glossdef> |
@@ -3344,20 +3376,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3344 | 3376 | ||
3345 | <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> | 3377 | <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> |
3346 | <glossdef> | 3378 | <glossdef> |
3347 | <para>Specifies the list of hardware features the | 3379 | <para> |
3348 | <link linkend='var-MACHINE'>MACHINE</link> supports. | 3380 | Specifies the list of hardware features the |
3349 | For example, including the "bluetooth" feature causes the | 3381 | <link linkend='var-MACHINE'><filename>MACHINE</filename></link> is capable |
3350 | <filename>bluez</filename> bluetooth daemon to be built and | 3382 | of supporting. |
3351 | added to the image. | 3383 | For related information on enabling features, see the |
3352 | It also causes the <filename>connman</filename> recipe | 3384 | <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>, |
3353 | to look at <filename>MACHINE_FEATURES</filename> and when it | 3385 | <link linkend='var-COMBINED_FEATURES'><filename>COMBINED_FEATURES</filename></link>, |
3354 | finds "bluetooth" there it enables the bluetooth | 3386 | and |
3355 | support in ConnMan. | 3387 | <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> |
3388 | variables. | ||
3356 | </para> | 3389 | </para> |
3357 | 3390 | ||
3358 | <para> | 3391 | <para> |
3359 | For a list of features supported by the Yocto Project as shipped, | 3392 | For a list of hardware features supported by the Yocto |
3360 | see the "<link linkend='ref-features-machine'>Machine</link>" section. | 3393 | Project as shipped, see the |
3394 | "<link linkend='ref-features-machine'>Machine Features</link>" | ||
3395 | section. | ||
3361 | </para> | 3396 | </para> |
3362 | </glossdef> | 3397 | </glossdef> |
3363 | </glossentry> | 3398 | </glossentry> |