Custom attributes in the XML schema, such as `applicable-vms` and `views`,
are designed to recursively inherit those of the parent. Thus, the
effective attribute of an element should be derived by its lowest ancestor
that has that attribute explicitly defined. Looking up only one level would
not be sufficient.
This patch updates the `configdoc.xsl` to derive the effective attributes
properly so that icons in the generated doc properly reflects what is
specified in the schema. Addresses ACRN-7347
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
In markdown a single backtick around a term says to format it as
fixed-width text, e.g., `fixed-width text`. The rst language uses
double back-ticks, e.g., ``fixed-width text``.
Fix misuses of single backtick in our documentation.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Update known-issues processing and tweak conf.py and requirements.txt
(for PyPI package versions) to handle a broader version of
doc-generation tools (sphinx, breathe, docutils, etc.). This should
let us move to Ubuntu 22.04 while maintaining doc-build compatibility
with older tool versions available with Ubuntu 20.04 (doxygen in particular).
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
These changes are compatible with both the Ubuntu 20.04 and 22.04
documentation build processes.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
We have real fix in PR#8222, thus remove the workround in document.
delete the command: sudo pip3 install tqdm
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
Tracked-On:8155
The application binary interface (ABI) is an important aspect of
hypercalls. But unfortunately it is not yet defined anywhere in the current
HLD.
This patch adds the current ABI specification to the hypercall section of
HLD.
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
The ACRN Configurator release 3.1 following the release 3.0 logic, so
the COM2 still used for S5.
This patch modify the "The release v3.0 ACRN Configurator assigns… …"
to "The release v3.0+ ACRN Configurator assigns… …" and refine a typo
issue.
Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@intel.com>
to avoid misleading for users, delete the description about
hypervisor relocation disabling, since it is not officially
supported by ACRN configurator now.
Tracked-On: #8133
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
changed-docs.sh (and the accompanying awk script) shows docs changed
between a previous release branch and the current master branch, in a format that
can be used for the releae notes (a list of :ref: items).
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Modified misc/config_tools/configurator/requirements.txt
and misc/config_tools/requirements.txt. Updated getting-started.rst
and acrn_configurator_tool.rst.
Tracked-On: #7975
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
* Fix missing /build folder in copy command in GSG
* Mention USB stick needs formatting for large files when used for the
sample app (but we'll put that into GSG too).
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Previously the sample apps needed to be run as root, but with a recent
update they could be run as a normal (acrn) user. Update the sample app
to use sudo for running these sample app components in case the user
doesn't login as root. Also, split running the background app and the
foreground app into two commands to eliminate some confusion.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Make the GSG more consistent with the sample app doc and show how to use
scp to transfer files between the dev and target machines.
Also add a mention of the sample app guide at the end of the GSG.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Address comments from DX reviews, and update the cyclictest histogram
output (improvements from PR #8026)
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The Getting Started Guide specifies that we need to install the Python packages lxml, xmlschema, and defusedxml.
However, a make clean involves the execution of the Python script manager.py. This script imports the package requests.py, which might not be installed if the developer follows the Getting Started Guide.
Add requests follow this command in GSG.
sudo pip3 install "elementpath==2.5.0" lxml "xmlschema==1.9.2" defusedxml tqdm requests
[External_System_ID] ACRN-9144
Tracked-On: #8029
Signed-off-by: Zhang Wei <wei6.zhang@intel.com>
* Fix preempt-rt patched kernel label on wrong VM
* Fix path copying hmi_vm.img and rt_vm.img (they're not in ~/acrn-work
directory)
* Rename png images to avoid potential conflicts with other images on the
system.
* Fix Ubuntu wecome message text after logging into RT_VM
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1. Add the move iasl binary to the /usr/sbin directory.
2. Modify login RT_VM user to root user.
Signed-off-by: Liu Long <long.liu@linux.intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
After review with engineering, we added material for showing what a
successful hmi_vm.img build ending looks like (and a hint of what to do
if it looks like the build failed. Also added using a dhclient commmand
to the instructions in case the HMI_VM didn't get an IP address.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
GSG was recently updated to use a requirements.txt for python
dependencies, but that file doesn't exist in the repo at the v3.0 tag
the instructions say to use. Revert to not use a requirements.txt until
we get this figured out.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Edits preparing for using a requirements.txt introduced an error in the
step order (using a directory before it was created).
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The new acrn-kernel for v3.1 expects gelf.h that's installed with the libelf-dev
package that's not listed as a dependency in the GSG. Without this
package, building acrn-kernel fails.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Update Getting Started Guide to clarify and improve descriptions of
steps, including adding example commands instead of just describing
them, adding more information about system requirements, making certain
steps explicit, squash the long list of packages to install into fewer
lines, and more.
Move cloning ACRN hypervisor and kernel earlier in the instructions
(anticipating use of a requirements.txt coming from the repo).
[External_System_ID] ACRN-9285
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
ACRN hypervisor shell has been improved to be bash-like shell, so update
its usage
Tracked-On: #7931
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
While we're waiting for a more complete list of specific package version
requirements, let's fix the xmlschema and elementpath version mismatch
now.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Updated the description of Security VM Features per review comments, and
made the option visible (again) in the configurator as an advanced
hypervisor option.
Created a new glossary entry for "Security VM", referenced by this new
description and tooltip.
Tweak wording of virtio console and input device descriptions.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Tracked-On: #7968
Remind readers that internet access from a corporate network typically
requires configuring proxy information.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
In the "Enable ACRN Secure Boot With EFI-Stub" guide, to build EFI-Stub
smoothly, the installation of "gnu-efi" package is added to GSG.
Tracked-On: #7935
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
Clarify description of CVE fix (only impacts ACRN implementation on
Alder Lake platforms), and improve description of the ACRN shell's new
vmexit command.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Update security advisory for release_3.0.1
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
We aluready updated the GSG to discuss how to find and address errors
when using the configurator (specifically doing a save scenario to check
for errors or to verify all errors were resolved). Add a description of
this error interaction model to the configurator tool documentation.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Documentation for the sample app isn't ready for the public, so let's
not add it to the toctree yet (use the :orphan: role to stop Sphinx from
complaining about an unreferenced .rst file)
Tracked-On: #7820
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Add the ACRN Sample App document (README.rst) to the toctree
Convert the README.rst from Dos to Unix text file format
Tracked-On: #7820
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Explain that consistency and validation checks of the schema are done
when a schema is imported/created or when it's saved, and after you
resolve any errors, you need to save the scenario to force another
schema validation.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The current code assign COM2 to S5 feature as a commutation vUART, so
the COM2's IO port which value is 0x2F8 could not assign to another
vUART connection.
This patch add a note and modify the legacy vUART sample, change the
default IO port to 0x3E8 which was known as COM3.
Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
Modified the copyright year range in code, and corrected "int32_tel"
into "Intel" in two "hypervisor/include/debug/profiling.h" and
"hypervisor/include/debug/profiling_internal.h".
Tracked-On: #7559
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
This patch updates the documentation according to the refinement on
the detection and the version verification of "iasl".
Tracked-On: #7880
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Adjusted the order of <your scenario xml> and
--launch <your launch xml> when merged data from
the launch XML to the scenario XML.
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
You need to be in the acrn-kernel directory in order to ``run make
distclean`` Also, remove mention of 6 VMs ...
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1. add link for ACRN configurator
2. update deb name.
3. update the patch of launch script.
4. update Python package dependencies.
Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
Update the Service VM rootfs to Ubuntu 20.04
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com
* Merge RDT and vCAT tutorials
* Update overview, dependencies and constraints
* Update to match Configurator UI instead of manually editing XML files
* Remove architectural details and instead point to high-level design documentation
Tracked-On: #6081
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
- The release v3.0 ACRN Configurator has an issue where you need to save the configuration twice to see the generated I/O or BDF address.
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
