From 4ec4ddc0ccfb3041aae82c00dda0d7c62750d2eb Mon Sep 17 00:00:00 2001 From: Geoffroy Van Cutsem Date: Wed, 14 Nov 2018 16:04:21 +0100 Subject: [PATCH] Documentation: clean-up of isolated README.rst files Clean up of a couple of README.rst files located respectively under hypervisor/ and devicemodel/ to remove obsolete and unmaintained information. Both hold a basic introduction about the folder content and refer to the official documentation website for more detailed information. Tracked-On: #1827 Signed-off-by: Geoffroy Van Cutsem --- devicemodel/README.rst | 76 +++--------------------------------------- hypervisor/README.rst | 40 +++++++++++----------- 2 files changed, 23 insertions(+), 93 deletions(-) diff --git a/devicemodel/README.rst b/devicemodel/README.rst index ff02111fb..eef8ecf42 100644 --- a/devicemodel/README.rst +++ b/devicemodel/README.rst @@ -3,78 +3,10 @@ ACRN Device Model Introduction ============ -The ACRN Device Model provides **device sharing** capabilities between the Service OS and Guest OSs. It is a component that is used in conjunction with the `ACRN Hypervisor`_ and this is installed within the Service OS. You can find out more about Project ACRN on the `Project ACRN documentation`_ website. - - -Building the Device Model -========================= - -Build dependencies -****************** - -* For Clear Linux - -.. code-block:: console - - sudo swupd bundle-add os-clr-on-clr \ - os-utils-gui-dev - -* For CentOS - -.. code-block:: console - - sudo yum install gcc \ - libuuid-devel \ - openssl-devel \ - libpciaccess-devel \ - libusb-devel - -* For Fedora 27 - -.. code-block:: console - - sudo dnf install gcc \ - libuuid-devel \ - openssl-devel \ - libpciaccess-devel \ - libusb-devel - -Build -***** -To build the Device Model - -.. code-block:: console - - make - -To clean the build artefacts - -.. code-block:: console - - make clean - -Runtime dependencies -******************** - -* On CentOS - -.. code-block:: console - - sudo yum install openssl-libs \ - zlib \ - libpciaccess \ - libuuid \ - libusb - -* On Fedora 27 - -.. code-block:: console - - sudo dnf install openssl-libs \ - zlib \ - libpciaccess \ - libuuid \ - libusb +The ACRN Device Model provides **device sharing** capabilities between the +Service OS and Guest OSs. It is a component that is used in conjunction with +the `ACRN Hypervisor`_ and this is installed within the Service OS. You can +find out more about Project ACRN on the `Project ACRN documentation`_ website. .. _`ACRN Hypervisor`: https://github.com/projectacrn/acrn-hypervisor .. _`Project ACRN documentation`: https://projectacrn.github.io/ diff --git a/hypervisor/README.rst b/hypervisor/README.rst index 0948e4ecb..515d3badf 100644 --- a/hypervisor/README.rst +++ b/hypervisor/README.rst @@ -1,25 +1,23 @@ -Embedded-Hypervisor -################### +ACRN Hypervisor +############### -This open source embedded hypervisor defines a software architecture for -running multiple software subsystems managed securely on a consolidated -system (by means of a virtual machine manager), and defines a reference -framework Device Model implementation for devices emulation +The open source `Project ACRN`_ defines a device hypervisor reference stack and +an architecture for running multiple software subsystems, managed securely, on +a consolidated system by means of a virtual machine manager. It also defines a +reference framework implementation for virtual device emulation, called the +“ACRN Device Model”. -This embedded hypervisor is type-1 reference hypervisor, running -directly on the system hardware. It can be used for building software -defined cockpit (SDC) or In-Vehicle Experience (IVE) solutions running -on Intel Architecture Apollo Lake platforms. As a reference -implementation, it provides the basis for embedded hypervisor vendors to -build solutions with an open source reference I/O mediation solution, -and provides auto makers a reference software stack for SDC usage. +The ACRN Hypervisor is a Type 1 reference hypervisor stack, running directly on +the bare-metal hardware, and is suitable for a variety of IoT and embedded +device solutions. The ACRN hypervisor addresses the gap that currently exists +between datacenter hypervisors, and hard partitioning hypervisors. The ACRN +hypervisor architecture partitions the system into different functional +domains, with carefully selected guest OS sharing optimizations for IoT and +embedded devices. -This embedded hypervisor is able to support both Linux* and Android* as -a Guest OS, managed by the hypervisor, where applications can run. +You can find out more about Project ACRN on the `Project ACRN documentation`_ +website. -This embedded hypervisor is a partitioning hypervisor reference stack, -also suitable for non-automotive IoT & embedded device solutions. It -will be addressing the gap that currently exists between datacenter -hypervisors, hard partitioning hypervisors, and select industrial -applications. Extending the scope of this open source embedded -hypervisor relies on the involvement of community developers like you! +.. _`Project ACRN`: https://projectacrn.org +.. _`ACRN Hypervisor`: https://github.com/projectacrn/acrn-hypervisor +.. _`Project ACRN documentation`: https://projectacrn.github.io/