mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-08-05 18:25:05 +00:00
8b0d1e45b9
Instead of trying to maintain the release notes for old releases in the current release, reference them in a previous archive. This eliminates the need to fix doc build errors by editing old release notes that reference material that no longer exists in the newer release. We use the intersphinx extension to support references to Sphinx-generated content from other projects. In our case, we're referencing the archived version of v2.7 documents that was the last release to generate release notes for all previous releases. This import is done in conf.py. (Alternatively we could reference the release notes for a release in that specific release's archive, but that means fetchind the intersphinx inventory file (objects.inv) for every release, and seems like overkill.) This modification still allows putting multiple release notes in the doc/release_notes folder and they'll show up in the release notes index as they have in the past. Update the separate "archived" release notes section manually as needed. Also, adds a draft of the v3.0 release notes to verify the new release notes index page layout. Fixes: #7171 Tracked-On: #7171 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
82 lines
2.4 KiB
ReStructuredText
82 lines
2.4 KiB
ReStructuredText
.. _release_notes_3.0:
|
|
|
|
ACRN v3.0 (DRAFT)
|
|
#################
|
|
|
|
We are pleased to announce the release of the Project ACRN hypervisor
|
|
version 3.0.
|
|
|
|
ACRN is a flexible, lightweight reference hypervisor that is built with
|
|
real-time and safety-criticality in mind. It is optimized to streamline
|
|
embedded development through an open-source platform. See the
|
|
:ref:`introduction` introduction for more information.
|
|
|
|
All project ACRN source code is maintained in the
|
|
https://github.com/projectacrn/acrn-hypervisor repository and includes
|
|
folders for the ACRN hypervisor, the ACRN device model, tools, and
|
|
documentation. You can download this source code either as a zip or
|
|
tar.gz file (see the `ACRN v3.0 GitHub release page
|
|
<https://github.com/projectacrn/acrn-hypervisor/releases/tag/v3.0>`_) or
|
|
use Git ``clone`` and ``checkout`` commands::
|
|
|
|
git clone https://github.com/projectacrn/acrn-hypervisor
|
|
cd acrn-hypervisor
|
|
git checkout v3.0
|
|
|
|
The project's online technical documentation is also tagged to
|
|
correspond with a specific release: generated v3.0 documents can be
|
|
found at https://projectacrn.github.io/3.0/. Documentation for the
|
|
latest development branch is found at https://projectacrn.github.io/latest/.
|
|
|
|
ACRN v3.0 requires Ubuntu 20.04. Follow the instructions in the
|
|
:ref:`gsg` to get started with ACRN.
|
|
|
|
|
|
What's New in v3.0
|
|
******************
|
|
|
|
|
|
Upgrading to v3.0 From Previous Releases
|
|
****************************************
|
|
|
|
We highly recommended that you follow these instructions to
|
|
upgrade to v3.0 from previous ACRN releases.
|
|
|
|
Generate New Board XML
|
|
======================
|
|
|
|
Board XML files, generated by ACRN board inspector, contain board information
|
|
that is essential to build ACRN. Compared to previous versions, ACRN v3.0 adds
|
|
the following hardware information to board XMLs to support new features and
|
|
fixes.
|
|
|
|
- TBD
|
|
|
|
The new board XML can be generated using the ACRN board inspector in the same
|
|
way as ACRN v2.7. Refer to :ref:`acrn_config_workflow` for a complete list of
|
|
steps to deploy and run the tool.
|
|
|
|
Update Configuration Options
|
|
============================
|
|
|
|
Complete overhaul of configurator in v3.0...
|
|
|
|
|
|
Document Updates
|
|
****************
|
|
|
|
We've also made edits throughout the documentation to improve clarity,
|
|
formatting, and presentation.
|
|
|
|
|
|
Fixed Issues Details
|
|
********************
|
|
|
|
.. comment example item
|
|
- :acrn-issue:`5626` - [CFL][industry] Host Call Trace once detected
|
|
|
|
|
|
Known Issues
|
|
************
|
|
|