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>
