README: document sanity check skip

The variable that must be set to disable the virtualization distro
feature check was not documented in the README ... making it not
so useful.

Signed-off-by: Bruce Ashfield <bruce.ashfield@windriver.com>
This commit is contained in:
Bruce Ashfield 2017-10-22 09:04:47 -04:00
parent df188e48e7
commit 71dc7faa0c

21
README
View File

@ -4,10 +4,27 @@ meta-virtualization
This layer provides support for building Xen, KVM, Libvirt, and associated This layer provides support for building Xen, KVM, Libvirt, and associated
packages necessary for constructing OE-based virtualized solutions. packages necessary for constructing OE-based virtualized solutions.
The bbappend files for some recipe (e.g. linux-yocto) in this layer need to The bbappend files for some recipe (e.g. linux-yocto) in this layer needs to
have 'virtualization' in DISTRO_FEATURES to have effect. To enable them, add have 'virtualization' in DISTRO_FEATURES to have effect. To enable them, add
in configuration file the following line. in configuration file the following line.
DISTRO_FEATURES_append = " virtualization"
DISTRO_FEATURES_append = " virtualization"
If meta-virtualization is included, but virtualization is not enabled as a
distro feature a warning is printed at parse time:
You have included the meta-virtualization layer, but
'virtualization' has not been enabled in your DISTRO_FEATURES. Some bbappend files
may not take effect. See the meta-virtualization README for details on enabling
virtualization support.
If you know what you are doing, this warning can be disabled by setting the following
variable in your configuration:
SKIP_META_VIRT_SANITY_CHECK = 1
Also note that there are kvm and xen specific distro flags/features that depending
on your use case.
Dependencies Dependencies
------------ ------------