Commit Graph

303 Commits

Author SHA1 Message Date
David B. Kinder
db454dcdf1 doc: rst syntax tweaks
There are some subtle syntax errors in some documents that, while they
render OK (most of the time), are being caught by rstcheck (a
restructuredText linter). This PR fixes most of the issues encountered.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-03 14:37:37 -07:00
Vijay Dhanraj
cc952f73de Update doc/tutorials/acrn_on_qemu.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-29 09:10:42 -07:00
Vijay Dhanraj
2d6868d041 Update doc/tutorials/acrn_on_qemu.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-29 09:10:42 -07:00
Vijay Dhanraj
c0447aaad2 Update doc/tutorials/acrn_on_qemu.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-29 09:10:42 -07:00
Vijay Dhanraj
a81f6e2c62 doc: Enabling ACRN on top of QEMU/KVM
Tracked-On: #3198
Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-05-29 09:10:42 -07:00
Deb Taylor
c606d060ec Doc: Grammatical edits to GVT-d docs.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-21 17:17:16 -04:00
David B. Kinder
102aba8bc8 doc: Add visual OpenStack setup instructions
Update the OpenStack/libvirt tutorial with detailed instructions with
screen shots. Add patch file mention in the instructions to the docs
area so it's accessible.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-21 08:48:36 -07:00
Junming Liu
3ccbb20087 doc:add tutorial about enabling GVT-d
Previous tutorial "Enable GPU Passthrough on the Skylake NUC"
is out of date, so delete it here.

v2 -> v1:
add attached file

Signed-off-by: Junming Liu <junming.liu@intel.com>
2020-05-20 11:58:19 -04:00
Zide Chen
87adc93c96 doc: update cpu affinity related docs
Signed-off-by: Zide Chen <zide.chen@intel.com>
2020-05-18 11:13:37 -04:00
Yuan Liu
a99858e9f6 doc: Update acrn edk2 download path
Update acrn edk2 source code download path for WaaG
secure boot feature

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-05-14 08:50:55 -07:00
guoqingxz
fb65c42468 doc: update build ACRN doc
Signed-off-by: guoqingxz <guoqingx.q.zhang@intel.com>
2020-05-11 09:31:24 -04:00
fangfang.shen
2db40c9956 doc: update GSG for ACRN V1.6.1.
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-05-10 14:35:54 -07:00
David B. Kinder
5850f00880 doc: update libvirt guide
Clean up command-line formatting, reduce line length, prepare for
further technical review.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-08 08:32:41 -07:00
Conghui Chen
d7e1f570d4 doc: cpu-sharing doc update
Update cpu-sharing document.

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2020-05-08 08:31:17 -07:00
Deb Taylor
bfe2a1c525 Doc: Initial file: Config ACRN using OpenStack & libvert
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-07 16:12:10 -04:00
David B. Kinder
765e40bdb1 doc: edit notes on serial connection need
Clarify wording on tutorial notes about needing a serial port connection.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-07 10:08:21 -07:00
Geoffroy Van Cutsem
7689b92ed0 doc: update Zephyr document to indicate a serial port is needed
Update the "Run Zephyr as the User VM" document to add a note indicating a
serial port connection to the platform may be needed to see the Zephyr output
depending on the scenario  used (SDC vs. industrial).

Tracked-On: #4553
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-07 08:52:11 -07:00
Geoffroy Van Cutsem
a69a5608da doc: add note to the Celadon User VM tutorial
Add a note to the "Run Celadon as the User VM" tutorial to indicate a serial
port connection to the platform (or change of the default config) may be needed
if the user uses a scenario other than SDC (the default one in the doc).

Tracked-On: #4554
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-05-07 08:51:41 -07:00
David B. Kinder
c431199f41 doc: fix misspellings
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-05 09:07:45 -07:00
David B. Kinder
b0c7993309 doc: remove stray UTF-8 characters
Convert UTF-8 characters (typically pasted from Word for smart quotes
and such) into equivalent ASCII characters.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-04 16:16:32 -07:00
Deb Taylor
1df539b76c Doc: Updated "Advanced Guides" titles for naming consistency
Updated WaaG file

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-04 13:17:02 -04:00
David B. Kinder
f9824261e6 doc: fix broken link to touch monitor
Fixes: #4503

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-04 09:35:30 -07:00
Conghui Chen
dcb809e824 doc: update cpu-sharing doc
change IORR to BVT, update affinity related info.

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2020-05-03 17:00:03 -07:00
Victor Sun
1675dabddc doc: build from source update
As acrn-hypervisor Makefile rule changed, the doc need to be changed
accordingly.

Signed-off-by: Victor Sun <victor.sun@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-03 16:34:08 -07:00
Victor Sun
829083c46f doc: hv elements update
The hypervisor configuration is integrated into scenario XML now,
update the elements description for hv section.

Some elements in launch XML are updated also.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-05-03 16:34:08 -07:00
Victor Sun
3f5bfe5511 doc: reference code update for cpu sharing
The VM configuration struct initialization method is slightly changed
recently, so reference code for cpu shaing need to be changed
accordingly.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-05-03 16:34:08 -07:00
Victor Sun
515e478282 doc: remove sdc2 and update industry scenario
Remove SDC2 scenario since usages under SDC2 could be supported by
INDUSTRY scenario which would support up to 7 post-launched VMs.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-05-03 16:34:08 -07:00
David B. Kinder
0bd30017eb doc: update windows as UOS tutorial
Fix consistent spelling of GVT-g and malformed bullet list.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-29 15:38:27 -07:00
fangfang.shen
d6a1bd8ca2 doc:update waag gsg after enabling gvt-d and cpu-sharing.
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-04-29 11:43:29 -07:00
Geoffroy Van Cutsem
c8f789ee90 doc: add note about capricious UP2 EFI firmware
The UP2 EFI firmware is a bit capricious and does not consistantly keep the
boot order after adding one using `efibootmgr`. There is no magic recipe (or
known reliable sequence) and hence we add a note warning the user that this
can happen, and when it does the only solution is to try modifying some more
the list of boot entries (inc. re-ordering them).

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-04-29 11:37:34 -07:00
Deb Taylor
d797fefb59 Doc: Grammatical edits to acrn config tool doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-27 15:27:55 -04:00
Shuang Zheng
de36607d48 doc: add dynamic config in web app of acrn configuration tool
Add document to dynamically create scenario config and launch config,
dynamically add or delete VM settings in scenario and launch config
in web app of acrn configuration tool

Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
2020-04-27 07:10:20 -04:00
David B. Kinder
17445c1914 doc: update docker build with numbered steps
Use the (new) numbered instruction style in one of our tutorials to
check it out.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-26 15:20:56 -07:00
Deb Taylor
b514eba9d6 Doc: Modify Getting Started and Advanced Guides sections (navigation)
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-24 13:03:54 -04:00
Geoffroy Van Cutsem
3e79287cd3 doc: fix a coupe of typos in rtvm_performance_tips.rst doc
Fix a couple of typos that sneaked in in the 'rtvm_performance_tips.rst'
document.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-04-22 12:25:21 -04:00
David B. Kinder
714b3a35d6 doc: edits for rtvm_performance_tips doc
Fixed windows line endings, improved tip formatting, additional grammar
and content simplification edits.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-22 10:35:33 -04:00
lirui34
aef1f4cde8 doc: remove the kbl-nuc flow pic from the partition mode gsg.
Signed-off-by: lirui34 <ruix.li@intel.com>
2020-04-21 13:51:55 -04:00
Deb Taylor
1815ed4e14 Doc: Minor grammatical edits to GSG for ACRN logical part mode
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-17 11:20:29 -04:00
lirui34
3b21146dfb doc: update partition mode tutorial to use whl board.
Signed-off-by: lirui34 <ruix.li@intel.com>
2020-04-17 09:56:07 -04:00
Deb Taylor
decd89e48d Doc: Initial version of ARCN RTVM Perf Tips
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-16 20:44:09 -04:00
David B. Kinder
4b1dfe9632 doc: remove trailing spaces
Remove trailing spaces on lines to avoid potential issues with git

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-15 11:46:06 -07:00
David B. Kinder
237997f3f9 doc: change UOS/SOS to User VM/Service VM
First pass at updating obsolete usage of "UOS" and "SOS"

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-15 10:48:25 -07:00
David B. Kinder
f5f16f4e64 doc: clean up utf8 characters
Stray non-ASCII characters can creep in when pasting from Word or Google
Docs, particularly for "smart" single and double quotes and non-breaking
spaces.  Change these to their ASCII equivalents.  Also fixed some very
long lines of text to wrap at 80-ish characters.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-15 10:17:54 -07:00
David B. Kinder
1e8269b5f7 doc: fix misspellings
Fix misspellings missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-10 08:58:54 -07:00
Deb Taylor
f282e8de0a Doc: Minor grammatical updates to rt_industry.html and building_acrn_in_docker.html
Refer to PRs 4568 and 4559.

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-01 11:38:54 -04:00
lirui34
24cfdacb99 doc: update industry gsg to v1.6 release
- Update quick setup script to support whl board.
- Change board to WHL NUC.
- Change the Service VM disk to NVMe.
- Update CL version to 32680 and ACRN tags info.
- Update CL and acrn tag versions for waag user vm tutorial.

Signed-off-by: lirui34 <ruix.li@intel.com>
2020-04-01 05:42:15 -04:00
fangfang.shen
122b2185ce Doc: update building acrn in docker for V1.6
One known issue :acrn-issue:`4560` during build ACRN HV.
Please refer to  next section to get Docker Image from Docker Hub.

Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-04-01 05:38:22 -04:00
Deb Taylor
ac6be7b591 Doc: Minor edits to Xenomai page
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-29 20:43:00 -04:00
Deb Taylor
284d63f11a Doc: Edits to MBA and CAT documentation.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-29 18:57:57 -04:00
Vijay Dhanraj
a2763ab7f0 doc: Add MBA documentation and update doc for CAT
This patch updates CAT documentation as well as adds
documentation support for newly added MBA feature.

Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-03-27 16:58:20 -04:00