From d7e34acfe1aa23576508d4ffeaed2eedc2bb3efd Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Tue, 8 Sep 2020 15:12:54 -0700 Subject: [PATCH] doc: add pointers to meta-acrn layer repo docs meta-acrn is a Yocto Project layer repo with recipes for building a Service and User VM OS using Yocto Project. While the information there is sparse, for the experienced YP developer is might be enough. Signed-off-by: David B. Kinder --- doc/develop.rst | 1 + doc/tutorials/using_yp.rst | 41 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 doc/tutorials/using_yp.rst diff --git a/doc/develop.rst b/doc/develop.rst index ccce3487c..68ac82604 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -33,6 +33,7 @@ Service VM Tutorials :maxdepth: 1 tutorials/running_deb_as_serv_vm + tutorials/using_yp User VM Tutorials ***************** diff --git a/doc/tutorials/using_yp.rst b/doc/tutorials/using_yp.rst new file mode 100644 index 000000000..9a3d9c4fd --- /dev/null +++ b/doc/tutorials/using_yp.rst @@ -0,0 +1,41 @@ +.. _using_yp: + +Using Yocto Project with ACRN +############################# + +The `Yocto Project `_ (YP) is an open source +collaboration project that helps developers create custom Linux-based +systems. The project provides a flexible set of tools and a space where +embedded developers worldwide can share technologies, software stacks, +configurations, and best practices used to create tailored Linux images +for embedded and IOT devices, or anywhere a customized Linux OS is +needed. + +Yocto Project layers support the inclusion of technologies, hardware +components, and software components. Layers are repositories containing +related sets of instructions which tell the Yocto Project build system +what to do. + +The meta-acrn layer +******************* + +The meta-acrn layer integrates the ACRN hypervisor with OpenEmbedded, +letting you build your Service VM or Guest VM OS with the Yocto Project. +The `OpenEmbedded Layer Index's meta-acrn entry +`_ +tracks work on this meta-acrn layer and lists the available meta-acrn +recipes including Service and User VM OSs for Linux Kernel 4.19 and 5.4 +with the ACRN hypervisor enabled. + +Read more about the meta-acrn layer and how to use it, directly from the +`meta-acrn GitHub repo documentation +`_: + +* `Getting Started guide + `_ +* `Booting ACRN with Slim Bootloader + `_ +* `Testing Procedure + `_ +* `References + `_