Commit Graph

1073 Commits

Author SHA1 Message Date
David B. Kinder
5c35fa84ab doc: fix image size on 404 page
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-08 16:04:05 -07:00
David B. Kinder
b67d88cab3 doc: fix 404 processing
Some additional tweaks to the publish script, image, and root-level
redirect to fix a redirect recursion problem.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-08 14:37:04 -07:00
David B. Kinder
dffa75e50f doc: add a custom 404 page
Add a site-wide custom error page for broken references within the site.
Besides giving a better user experience, it's also easier to track
broken links to the site using google analytics (looking for hits to the
404.html page and noticing the referrer.

Note we only "publish" the custom 404.html when publishing the latest
documents (not for released versions) so we always get the latest
left-navigation menu when a 404 error occurs.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-08 12:53:37 -07:00
lirui34
f981ddbd1b doc: gsg quick setup script issue fix.
- Fix swupd mirror issue
- Fix bootloader config file not detect correctly issue

Signed-off-by: lirui34 <ruix.li@intel.com>
2020-04-08 11:49:49 +08:00
David B. Kinder
3a326056fd doc: some additional google analytics code
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-07 17:18:31 -07:00
David B. Kinder
7b969d15c0 doc: organize security advisory doc
Add headings to organize security advisory doc by release to make it a
bit easier to read.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-07 15:10:21 -07:00
David B. Kinder
a5ef52094f doc: remove "Glossary" icon box on home page
Adding a big box for the glossary disturbed the home page layout and is
overkill for this one document. Adding the glossary to the left
navigation menu is sufficient.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-07 15:09:56 -07:00
David B. Kinder
415b6f5030 doc: add google analytics tag
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-07 15:08:44 -07:00
David B. Kinder
58fc6eeec9 doc: add 1.6 to doc version menu
Update doc version choice selector with the 1.6 release

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-01 20:18:14 -07:00
Deb Taylor
de3bc3faec Doc: Release Notes update based on DKinder edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-01 19:28:25 -04:00
Deb Taylor
9a805f6c6b Doc: Grammactical edits to Release Notes 1.6
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-01 14:28:31 -04: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
fuzhongl
0244bcaf5d Doc: releasenotes_1.6
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-04-01 05:40:09 -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
c4531e3bc0 Minor edits to VT-d page.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-31 17:56:07 -04:00
Binbin Wu
1c925187ab doc: vt-d: update the description of snoop control
Tracked-On: #4509
Signed-off-by: Binbin Wu <binbin.wu@intel.com>
2020-03-31 15:39:44 -04:00
Deb Taylor
37291fa890 Doc: Grammatical/style edits to split device model page
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-29 22:17:07 -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
Deb Taylor
4064286e07 Doc Minor edits to Security page
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-29 18:57:11 -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
Li Fei1
86957d702a doc: introduce Split Device Model feature for ACRN
Introduce Split Device Model feature for ACRN. Now we only implement pass through
PCI(e) device of it.

Tracked-On: #4371
Signed-off-by: Li Fei1 <fei1.li@intel.com>
2020-03-27 16:41:58 -04:00
Tw
0f9e9ee0c4 Doc: add instructions for using Xenomai as UOS
Signed-off-by: Tw <wei.tan@intel.com>
2020-03-27 16:39:39 -04:00
Yonghua Huang
3de67830f6 doc: update security advisory for v1.6 release
Update mitigations for security vulnerabilities
  for ACRN v.16 release.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-03-27 16:35:51 -04:00
Deb Taylor
d5461410b3 Doc: Add Glossary to Nav Bar and Home Page
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-25 14:15:37 -04:00
Deb Taylor
47b1a936ad Doc: Remove Construction Progress label from site
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-25 13:39:51 -04:00
David B. Kinder
268df234a3 doc: fix docs with windows line endings
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-03-25 13:14:43 -04:00
Deb Taylor
c3582dcd04 Doc: Edits to workaround note for EFI command line option string issue.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-24 21:11:52 -04:00
fuzhongl
4ea3676f26 Doc: add space at the end of efibootmgr bootloader
This is a workaround for the issue in efi-stub: If the EFI option is loaded to a memory range which is not all zero filled,
it's possible the garbage string appended to bootloader name string.
Which could make system can't boot.

Add an extra space to the EFI option to make sure space could be used to detect the end of bootloader name string.

Once the fixing patch is merged, we don't need this extra space.
But to make old ACRN work, we'd like to keep the space here.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Yin Fengwei <fengwei.yin@intel.com>
2020-03-24 19:34:44 -04:00
Deb Taylor
e928ca4b3a Doc: Update mem-mapping image in hv-memmgt.html
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-23 16:25:49 -04:00
Deb Taylor
ec20413a88 Doc: Update mem-mapping image in hv-memmgt.html
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-23 16:25:49 -04:00
Deb Taylor
ddb18283a2 Doc: Grammatical edits to using_windows_as_uos.rst
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-22 20:57:45 -04:00
ffshen
b9bf38e8a0 doc: update waag GSG according to the latest method
Delete Redhad virtio drive, only keep Oracle as reference.
Delete "inject driver into ISO" part, and update to the latest workable
method.
In a word, QA just need maintain one latest workable method in GSG for creating WaaG image.

Signed-off-by: ffshen <fangfang.shen@intel.com>
2020-03-22 11:37:32 -04:00
David B. Kinder
a086d72974 doc: fix docs with broken links
Fix links in documentation that have moved (e.g.,
clearlinux.org/documentation moved to docs.01.org/clearlinux/latest).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-03-22 11:35:17 -04:00
Deb Taylor
537f59f751 doc: Grammatical updates to SR-IOV virt doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-18 21:02:27 -04:00
Yuan Liu
7b3c3c6bcf doc: introduce SR-IOV virtualization
The SR-IOV virtualization document

Tracked-On: #4433
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-03-18 12:15:49 -04:00
Deb Taylor
b09f07e200 doc: More re-org updates
Add ACRN Open Source Roadmap 2020 link to Intro/What is ACRN page
Add ACRN blog link to ACRN Intro page (under Roadmap)
Move ACRN Shell Commands to 'Tools' under Advanced Guides page

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-17 11:28:26 -04:00
lirui34
bf7766fc6d doc: Update build celadon instruction link
Signed-off-by: lirui34 <ruix.li@intel.com>
2020-03-17 11:02:14 -04:00
Deb Taylor
1f50b07405 Doc: Update re-org'd ACRN index page and What is ACRN.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-16 17:16:00 -04:00
Deb Taylor
fd2330c924 Doc: Changed lines in RN 1.0 and 0.1 to correct ref issue.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-12 22:55:03 -04:00
Deb Taylor
a5f9ef402e Doc: Fix tool ref tag on develop.rst page
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-12 22:26:14 -04:00
Deb Taylor
9a85e27430 Doc: Re-org documentation to improve user experience; see Nav Bar
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-12 21:54:36 -04:00
Deb Taylor
e641202c26 Doc: Add note to index.html file
Note invites users to view v1.5 branch while
latest build is under construction.

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-11 13:43:56 -04:00
David B. Kinder
3743edf9c1 doc: add site under construction page header
While the site is being reorganized, let's put a header on each page
letting people know.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-03-11 09:06:59 -07:00
Binbin Wu
667639b591 doc: fix a missing argument in the function description
One argument is missing for the function ptirq_alloc_entry.
This patch fixes the doc generation error.

Tracked-On: #3882
Signed-off-by: Binbin Wu <binbin.wu@intel.com>
2020-03-05 13:08:57 +08:00
Binbin Wu
76f2e28e13 doc: update hv device passthrough document
Fixed misspellings and rst formatting issues.
Added ptdev.h to the list of include file for doxygen

Tracked-On: #3882
Signed-off-by: Binbin Wu <binbin.wu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-03-04 18:05:15 -05:00
David B. Kinder
ee455574ed doc: update copyright year in doc footer
Update copyright 2019 to be 2020

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-02-26 09:32:32 -08:00
Li Fei1
e8479f84cd hv: vPCI: remove passthrough PCI device unuse code
Now we split passthrough PCI device from DM to HV, we could remove all the passthrough
PCI device unused code.

Tracked-On: #4371
Signed-off-by: Li Fei1 <fei1.li@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2020-02-24 16:17:38 +08:00
fuzhongl
cf3544b4ec Doc: VM2 vCPU affinity info update
Update VM2 vCPU affinity info to match with the picture of cpu_sharing

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-02-18 14:28:49 -05:00