mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-07-18 01:12:21 +00:00
doc: update v2.4 release notes
Update draft release notes with more information about documentation. Remove code-block extra indenting. Add label to roscube gsg so we can link to it (in the releaes notes). Fix style for :option: references to make them look more links links. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
parent
be487c23a2
commit
1e175b3146
@ -1,3 +1,5 @@
|
||||
.. _roscube-gsg:
|
||||
|
||||
Getting Started Guide for ACRN Industry Scenario With ROScube-I
|
||||
###############################################################
|
||||
|
||||
|
@ -114,7 +114,7 @@ In addition, the following new tools and packages are needed to build ACRN v2.4:
|
||||
Configuration File Format
|
||||
=========================
|
||||
|
||||
Starting from v2.4, Kconfig is no longer used, and the contents of scenario
|
||||
Starting with release v2.4, Kconfig is no longer used, and the contents of scenario
|
||||
XMLs have been simplified. You need to upgrade your own Kconfig-format files
|
||||
or scenario XMLs if you maintain any.
|
||||
|
||||
@ -154,7 +154,7 @@ can use ``xsltproc`` to transform your own scenario XML:
|
||||
New Configuration Options
|
||||
=========================
|
||||
|
||||
The following element is added to scneario XML in v2.4.
|
||||
The following element is added to scenario XML in v2.4.
|
||||
|
||||
- :option:`hv.FEATURES.ENFORCE_TURNOFF_AC`
|
||||
|
||||
@ -190,9 +190,8 @@ the best indentation in converted XML files.
|
||||
Build Commands
|
||||
==============
|
||||
|
||||
While the ``make`` command-line variables are kept backward compatible, users
|
||||
are recommended to update the usage of variables ``BOARD_FILE``,
|
||||
``SCENARIO_FILE``, and ``RELEASE``.
|
||||
We recommend you update the usage of variables ``BOARD_FILE``,
|
||||
``SCENARIO_FILE``, and ``RELEASE``:
|
||||
|
||||
- ``BOARD_FILE`` should be replaced with ``BOARD``. There is no need to specify
|
||||
``BOARD`` and ``BOARD_FILE`` at the same time.
|
||||
@ -201,14 +200,14 @@ are recommended to update the usage of variables ``BOARD_FILE``,
|
||||
``n`` (previously was ``0``).
|
||||
|
||||
``BOARD_FILE`` and ``SCENARIO_FILE`` can still be used but will take effect
|
||||
only when ``BOARD`` and ``SCENARIO`` are not defined. They will be removed in
|
||||
only if ``BOARD`` and ``SCENARIO`` are not defined. They will be removed in
|
||||
a future release.
|
||||
|
||||
Patches on Generated Sources
|
||||
============================
|
||||
|
||||
The C files generated from board and scenario XMLs have been removed from the
|
||||
repository in v2.4. Instead they will be generated when building the
|
||||
repository in v2.4. Instead they will be generated in the build output when building the
|
||||
hypervisor.
|
||||
|
||||
Typically you should be able to customize your scenario by modifying the
|
||||
@ -217,7 +216,7 @@ possible, you can still register one or more patches that will be applied to
|
||||
the generated files by following the instructions in
|
||||
:ref:`acrn_makefile_targets`.
|
||||
|
||||
Note that modifying generated files is by no means a recommended practice.
|
||||
Note that modifying generated files is not a recommended practice.
|
||||
When you find any configuration that is not flexible enough to meet your
|
||||
needs, please do not hesitate to let us know by sending mail to `the mailing
|
||||
list <https://lists.projectacrn.org/g/acrn-dev>`_ or submitting issues on
|
||||
@ -226,11 +225,22 @@ list <https://lists.projectacrn.org/g/acrn-dev>`_ or submitting issues on
|
||||
Document Updates
|
||||
****************
|
||||
|
||||
New and updated reference documents are available, including:
|
||||
With the changes to ACRN configuration noted above, we made substantial updates
|
||||
to the ACRN documentation around configuration and options, as listed here:
|
||||
|
||||
.. rst-class:: rst-columns2
|
||||
|
||||
* :ref:`hv-config`
|
||||
* :ref:`scenario-config-options`
|
||||
* :ref:`acrn_configuration_tool`
|
||||
* :ref:`vuart_config`
|
||||
* :ref:`acrn-dm_parameters`
|
||||
* :ref:`kernel-parameters`
|
||||
|
||||
Additional new or updated reference documents are also available, including:
|
||||
|
||||
.. rst-class:: rst-columns2
|
||||
|
||||
* :ref:`APL_GVT-g-hld`
|
||||
* :ref:`hld-devicemodel`
|
||||
* :ref:`hld-trace-log`
|
||||
* :ref:`hld-virtio-devices`
|
||||
@ -241,23 +251,20 @@ New and updated reference documents are available, including:
|
||||
* :ref:`vt-d-hld`
|
||||
* :ref:`virtio-console`
|
||||
* :ref:`virtio-i2c`
|
||||
* :ref:`getting-started-building`
|
||||
* :ref:`roscube-gsg`
|
||||
* :ref:`rt_industry_ubuntu_setup`
|
||||
* :ref:`introduction`
|
||||
* :ref:`scenario-config-options`
|
||||
* :ref:`how-to-enable-acrn-secure-boot-with-grub`
|
||||
* :ref:`acrn_configuration_tool`
|
||||
* :ref:`acrn_doc`
|
||||
* :ref:`gpu-passthrough`
|
||||
* :ref:`rt_performance_tuning`
|
||||
* :ref:`setup_openstack_libvirt`
|
||||
* :ref:`using_windows_as_uos`
|
||||
* :ref:`vuart_config`
|
||||
* :ref:`acrn-dm_parameters`
|
||||
* :ref:`kernel-parameters`
|
||||
|
||||
Because we dropped deprivileged boot mode support (in v2.3), we also
|
||||
switched our Service VM of choice away from Clear Linux and have
|
||||
removed Clear Linux–specific tutorials. Deleted documents are still
|
||||
removed Clear Linux-specific tutorials. Deleted documents are still
|
||||
available in the `version-specific v2.1 documentation
|
||||
<https://projectacrn.github.io/v2.1/>`_.
|
||||
|
||||
|
5
doc/static/acrn-custom.css
vendored
5
doc/static/acrn-custom.css
vendored
@ -30,6 +30,11 @@
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* :option: link color */
|
||||
a code span.pre {
|
||||
color: #2980b9;
|
||||
}
|
||||
|
||||
/* tweak doc version selection */
|
||||
.rst-versions {
|
||||
position: static;
|
||||
|
Loading…
Reference in New Issue
Block a user