Preparing for upgrading to newer versions of doc building tools
including sphing, doxygen, breathe, docutils, etc. This PR's changes
still work find with the older tool versions, but should eliminate
issues found while moving to newer tool versions (later).
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Update some configuration settings that will be obsolete in the new
(1.8.17) doxygen release.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
As a DX improvement in the documentation, include the release version
(or Latest) in the breadcrumb header on every page. This can help
readers know which release version documentation they're using.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
As we're removing Clear Linux docs because of removing depriviliged boot
mode support, we can refer folks to the last known version of these docs
in the v2.1 release instead of just throwing a 404 error.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
From V2.2, we use the iasl tool to compile offline
ACPI binary for pre-launched VMs while building ACRN,
so we need to install the iasl tool in the ACRN
building environment. This doc is to describe how
to install the iasl tool and specify the version of
iasl at the chapter Install build tools and dependencies.
Tracked-On: #5350
Signed-off-by: Shixiong Zhang <shixiongx.zhang@intel.com>
Did a partial run of ACRN documents through Acrolinx to catch additional
spelling and grammar fixes missed during regular reviews.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Tiger Lake and Elkhart Lake processors added to the document as
supported processors but with no recommended platform.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Ivshmem hv-land solution emulates the ivshmem device in hypervisor
and the shared memory is reserved in the hypervisor's memory space.
And it can provide inter-vm communication for both pre-launched and
post-launched VMs.
This patch introduces the ivshmem hv-land solution including what
ivshmem hv-land is and how to use it.
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
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 <david.b.kinder@intel.com>
minor_ver should be le 2 when major_ver == 2.
Tracked-On: #5276
Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
Acked-by: Victor Sun <victor.sun@intel.com>
A previous update changed "slave" to "secondary", but the code comments
were changed to use "client", so update the documentation to match.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
ACRN 2.1 supports two virtual boot modes, deprivilege boot mode and
direct boot mode. The deprivilege boot mode’s main purpose is to support
booting Clear Linux Service VM with UEFI service support, but this
brings scalability problems when porting ACRN to new Intel platforms.
For the 2.2 release, deprivilege mode is removed, and only direct boot
is supported, and with this we've removed support for Clear Linux as the
service VM, which impacts over 50 ACRN documents. This PR removes
documents we don't intend to update, and fixes broken links that would
occur from references to these deleted docs.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Replace white/black master/slave terms with alternatives. We're not
changing "master" when used in the context of GitHub branches. GitHub
advises they have a plan to help this transition. In the text body we
rever to the "master" branch as the "main" branch, but leave any urls or
code-block commands still using "master".
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Also clear Linux is no longer supported either as SOS or post-launched VM kernel.
- When it mentions clear Linux, mostly replaced by Ubuntu.
- remove all contents re/lated to "UEFI boot".
- remove the term de-privilege mode, and direct mode as well.
Tracked-On: #5197
Signed-off-by: Zide Chen <zide.chen@intel.com>
Add description of the new Hybrid RT (hybrid_rt) scenario to the "What is ACRN"
documentation.
Tracked-On: #5203
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Add more explanations about the various ACRN modes of operation and how they are
used to construct more complex scenarios.
Tracked-On: #5196
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
- add a rule for pointer arithmetic operation
- add a rule about ABI conformance
- update GCC reference
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Some months were spelled out, others were abbreviated, making the list
of all release notes look a bit off.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Add fixed security vulnerabilities for v2.1 release.
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
build with XML file, "TARGET_DIR=xxx" does not work
Signed-off-by: guoqingxz <guoqingx.q.zhang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>