summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorBruce Ashfield <bruce.ashfield@windriver.com>2017-10-22 09:04:47 -0400
committerBruce Ashfield <bruce.ashfield@windriver.com>2017-10-22 09:07:38 -0400
commit71dc7faa0c7ceb9396e51bf7a77502c3781a54f2 (patch)
tree02e23b539a53cc3146e328094401e1ce23d0cc13 /README
parentdf188e48e73e3ee209fa4b923f522b195562bdaf (diff)
downloadmeta-virtualization-71dc7faa0c7ceb9396e51bf7a77502c3781a54f2.tar.gz
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>
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 19 insertions, 2 deletions
diff --git a/README b/README
index 49fda10c..7d842329 100644
--- a/README
+++ b/README
@@ -4,10 +4,27 @@ meta-virtualization
4This layer provides support for building Xen, KVM, Libvirt, and associated 4This layer provides support for building Xen, KVM, Libvirt, and associated
5packages necessary for constructing OE-based virtualized solutions. 5packages necessary for constructing OE-based virtualized solutions.
6 6
7The bbappend files for some recipe (e.g. linux-yocto) in this layer need to 7The bbappend files for some recipe (e.g. linux-yocto) in this layer needs to
8have 'virtualization' in DISTRO_FEATURES to have effect. To enable them, add 8have 'virtualization' in DISTRO_FEATURES to have effect. To enable them, add
9in configuration file the following line. 9in configuration file the following line.
10DISTRO_FEATURES_append = " virtualization" 10
11 DISTRO_FEATURES_append = " virtualization"
12
13If meta-virtualization is included, but virtualization is not enabled as a
14distro feature a warning is printed at parse time:
15
16 You have included the meta-virtualization layer, but
17 'virtualization' has not been enabled in your DISTRO_FEATURES. Some bbappend files
18 may not take effect. See the meta-virtualization README for details on enabling
19 virtualization support.
20
21If you know what you are doing, this warning can be disabled by setting the following
22variable in your configuration:
23
24 SKIP_META_VIRT_SANITY_CHECK = 1
25
26Also note that there are kvm and xen specific distro flags/features that depending
27on your use case.
11 28
12Dependencies 29Dependencies
13------------ 30------------