Commit Graph

1061 Commits

Author SHA1 Message Date
David B. Kinder
791b091bbe doc: more prep for upgrading doc build tools
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>
2020-11-01 10:12:17 -08:00
Shiqing Gao
76017ec67f doc: update coding guidelines
- add a rule for function parameter limit

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2020-10-30 08:36:21 -07:00
David B. Kinder
62d0088565 doc: doc spelling and grammer fixing
Continuing with additional spelling and grammar fixes missed during
retular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-30 08:32:53 -07:00
David B. Kinder
ec731bac0f doc: update doxygen configuration
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>
2020-10-26 09:20:50 -07:00
Shiqing Gao
c51a96a11b doc: update coding guidelines
- add a rule for "U" suffix
 - release the restrictions about function documentation

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2020-10-26 09:20:18 -07:00
Yonghua Huang
62a36ce34b doc: update 'hv-virt-interrupt.rst'
Update this file as 'vlapic_intr_msi()' is renamed.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-10-26 08:44:13 +08:00
David B. Kinder
5289a3eb97 doc: more spelling and grammar fixes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-03 09:11:19 -07:00
David B. Kinder
576a3b5947 doc: spelling and grammar improvements
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-01 18:08:00 -07:00
David B. Kinder
f300d1ff77 doc: update breadcrumb to include release version
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>
2020-10-01 14:53:29 -07:00
David B. Kinder
87bab944e6 doc: tweak 2.2 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-01 12:31:12 -07:00
David B. Kinder
fb45ad517e doc: redirect to 2.1 version for delete docs
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>
2020-09-30 14:41:16 -07:00
David B. Kinder
2ef34b21b3 doc: tweak 2.2 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-29 21:48:19 -07:00
fuzhongl
b69e650435 Doc: release_notes_2.2 update
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-09-29 21:34:33 -07:00
David B. Kinder
22abc0ec9e doc: add v2.2 to doc menu choices
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-29 18:31:58 -07:00
David B. Kinder
f9ddbdb49d doc: update rt_industry GSG and v2.2 release notes
Update release notes and fix merge conflict in PR #5365

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-29 17:51:07 -07:00
Shixiong Zhang
f094ae8e31 doc: add the iasl dependence
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>
2020-09-29 14:47:56 -07:00
Shixiong Zhang
40b3d719d9 doc: add the iasl dependence
add the the necessary tools

Signed-off-by: Shixiong Zhang <shixiongx.zhang@intel.com>
2020-09-29 14:47:56 -07:00
guoqingxz
c06948a8a4 doc: update doc for #5157 is closed as fix
during build, "TARGET_DIR=xxx" works well

Signed-off-by: guoqingxz <guoqingx.q.zhang@intel.com>
2020-09-29 14:40:50 -07:00
David B. Kinder
dd0fe54141 doc: Spelling and grammar tweaks
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>
2020-09-26 08:50:49 -07:00
David B. Kinder
d54347a054 doc: update HW to include new processors
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>
2020-09-25 10:04:17 -07:00
David B. Kinder
083c1298b6 doc: update IVSHMEM config detail
Slight wording tweak about the IVSHMEM_REGION description

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-22 12:44:35 -07:00
Shixiong Zhang
b964f5c2c4 doc: add IVSHMEM, mmio_resources, pt_intx in configuration tool
Add configration items: IVSHMEM, mmio_resources, pt_intx in
configuration tool documentation

Signed-off-by: Shixiong Zhang <shixiongx.zhang@intel.com>
2020-09-22 11:22:23 -07:00
Yuan Liu
a46aa9db4c doc: Add note about the maximum number of regions for hv-land
The maximum number of ivshmem shared memory regions cannot exceed 8

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-09-18 10:07:32 -07:00
David B. Kinder
30ac42c18e doc: edit intro grammar
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-15 16:57:08 -07:00
David B. Kinder
8133ffad2e doc: continue CL cleanup
Removed additional references to Clear Linux

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-15 14:45:22 -07:00
David B. Kinder
1509826a29 doc: update pre-launched VMs with offline ACPI
Bring change made to release_2.2 branch back to the main (master)
branch.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-15 09:09:23 -07:00
Yuan Liu
12557d2e2b doc: add ivhshmem hv-land introduction
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>
2020-09-14 10:20:39 -07:00
David B. Kinder
d7e34acfe1 doc: add pointers to meta-acrn layer repo docs
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>
2020-09-09 08:19:31 -07:00
Shuang Zheng
84c4c43833 acrn-config: fix csme passthrough issue for launch setting
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>
2020-09-07 16:42:56 +08:00
David B. Kinder
cd18a22faf doc: update virtio-i2c inclusive language
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>
2020-09-02 14:35:14 -07:00
David B. Kinder
54975e4629 doc: remove docs referencing Clear Linux
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>
2020-09-01 11:46:41 -07:00
David B. Kinder
fc1fc0eb8d doc: update inclusive language terms in docs
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>
2020-09-01 10:47:42 -07:00
Zide Chen
f945fe27ab doc: remove UEFI/de-privilege boot mode from docs
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>
2020-08-26 16:37:41 -07:00
David B. Kinder
066744ce5d doc: update FAQ
Remove obsolete information and Clear Linux/UEFI references.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-25 17:50:37 -07:00
David B. Kinder
a32074cda1 doc: update docbuild instructions for 2.2 release
Remove mention of Clear Linux

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-25 17:13:43 -07:00
Geoffroy Van Cutsem
32fc0dc2a7 doc: add hybrid_rt to "What is ACRN"
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>
2020-08-25 17:08:31 -07:00
Zide Chen
456dd43187 doc: remove the vboot module design example from sw_design_guidelines.rst
Since de-privilege boot mode is removed and vboot module is completely
rewritten.

Tracked-On: #5197
Signed-off-by: Zide Chen <zide.chen@intel.com>
2020-08-25 14:42:26 -07:00
Geoffroy Van Cutsem
49711b48e3 doc: add explanation about ACRN modes and scenarios
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>
2020-08-21 13:25:11 -07:00
David B. Kinder
e74cf71eb7 doc: spelling and grammar fixes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-20 08:09:21 -07:00
Li Fei1
7b38829576 doc: update document for "--acpidev_pt" and "--mmiodev_pt" features
Add guild how to add ACPI device and MMIO device passthrough support through
the cmdline.

Signed-off-by: Li Fei1 <fei1.li@intel.com>
2020-08-19 15:52:02 -07:00
Shiqing Gao
24b89eb8c4 doc: update coding guidelines
- 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>
2020-08-19 15:49:35 -07:00
David B. Kinder
84601935a1 doc: use consistent month names in release notes
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>
2020-08-10 16:15:46 -07:00
David B. Kinder
ba3b8e58a1 doc: add v2.1 to doc version menu
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 17:50:36 -07:00
David B. Kinder
7404fb08ff doc: update release notes about LAPIC timer in OVMF
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 14:43:36 -07:00
David B. Kinder
21893b3335 doc: fix mismatched ACRN version
Document was updated to use v2.1 but left a references to v1.6

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 09:07:16 -07:00
Yonghua Huang
c56fb35515 doc: update security advisory for v2.1 release
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>
2020-08-07 08:35:44 -07:00
guoqingxz
98aaf23f5c doc: add known issue:5157 for building-from-source.rst
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>
2020-08-07 08:23:25 -07:00
fuzhongl
3f7b6853ff Doc:release_notes_2.1 update
Add fixed issues and known issues.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 08:11:09 -07:00
David B. Kinder
99c855dd63 doc: use kbd consistently and fix misspellings
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-06 16:40:53 -07:00
Tao Yuhong
92f7a8a6a7 Doc: update user guide for Pre-Launched RT mode
The Release_2.1 use multiboot2, so update the example

Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2020-08-06 10:44:05 -07:00