Skip to content
Permalink
Browse files

boards/x86/acrn: fix documentation to reflect "demo" nature

The ACRN board configuration is not suitable for production use,
but many people are mistakenly using it as a starting point for
real-time applications. I've added a note to clarify.

Signed-off-by: Charles Youse <charles.youse@intel.com>
  • Loading branch information...
Charles Youse authored and andrewboie committed May 14, 2019
1 parent 605a390 commit 65352a740dfcb32c23fd37890542fa8bfe72500a
Showing with 13 additions and 1 deletion.
  1. +13 −1 boards/x86/acrn/doc/index.rst
@@ -15,12 +15,24 @@ through an open source platform. Check out the `Introduction to Project ACRN
<https://projectacrn.github.io/latest/introduction/>`_ for more information.

This baseline configuration can be used as a starting point for creating
custom ACRN UOS configurations. It currently supports the following devices:
demonstration ACRN UOS configurations. It currently supports the following
devices:

* I/O APIC
* local APIC timer
* NS16550 UARTs

.. note::
This ACRN board configuration is for illustrative purposes only.
Because of its reliance on virtualized hardware provided by ACRN,
it is not suitable for production real-time applications. Real-time
response under ACRN requires direct access to the underlying
hardware, so production applications should be derived from the
board configurations that describe that underlying hardware.

For example, if you wish to run an application under ACRN on an Up
Squared, start with the Up Squared board configuration, not this one.

Serial Ports
------------

0 comments on commit 65352a7

Please sign in to comment.
You can’t perform that action at this time.