Commit Graph

639 Commits

Author SHA1 Message Date
Geoffroy Van Cutsem
42b864b1f3 DM: update launch scripts to use OVMF.fd directly from the rootfs
* Update the launch scripts provided as examples on how to launch a Zephyr,
VxWorks or Windows User VM to directly use the 'OVMF.fd' bios file installed
by default in '/usr/share/acrn/bios/'
* Remove the OVMF.fd that was kept under 'doc/tutorials' (no longer needed)
* Adapt the tutorials to reflect this change

Tracked-On: #3673
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-09-18 11:52:37 +08:00
lirui34
a95a88c5b2 doc: Remove "or newer/higher" descriptions for other release notes and some tutorials.
ACRN tag is ONLY specific to one Clear Linux version.
For the tutorials, we just need to make sure the validated version is functional.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-11 12:56:42 -04:00
Minggui Cao
f41f9307cc DOC: add --pm_by_vuart setting guide.
new params: --pm_by_vuart is used to set power mananger by vuart
on ACRN; so add it to user guide.

Tracked-On: #3564
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
2019-09-11 16:43:22 +08:00
Yin Fengwei
476e9a2efe doc: Update document for --pm_notify_channel
Update the document for new parameter --pm_notify_channel.

Tracked-On: #3564
Signed-off-by: Yin Fengwei <fengwei.yin@intel.com>
2019-09-11 13:27:10 +08:00
David B. Kinder
5083aba379 doc: review edits for config tool doc
Update material from PR #3559 with review and clarity edits.
Added review comments.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-09-10 18:21:20 -07:00
Geoffroy Van Cutsem
ede5988587 doc: add 'logger_setting' parameter information to acrn-dm documentation
Add the '--logger_setting' parameter information to the 'acrn-dm' parameter
document.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-09-10 11:43:27 -04:00
Deb Taylor
96d51a5228 Add URL to GCC 7.3 Manual, Section 6
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-09 22:23:35 -04:00
deb-intel
8d27c1e11c Merge pull request #3632 from shiqingg/doc-lang-ext
doc: update Language Extensions in coding guidelines
2019-09-09 21:07:46 -04:00
deb-intel
67f3da2e97 Merge pull request #3567 from ClaudZhang1995/zy4
doc: update Build ACRN from Source
2019-09-09 19:13:25 -04:00
deb-intel
876d31122c Merge pull request #3640 from lirui34/add_new_glossary
doc: Add three new glossaries
2019-09-09 18:24:37 -04:00
deb-intel
ceec4d80a4 Merge pull request #3649 from gvancuts/zlib1g-dev-debian
doc: add 'zlib1g-dev' to list of dependencies in Debian
2019-09-09 18:11:55 -04:00
deb-intel
1b48773f7c Merge pull request #3653 from deb-intel/remove_newerRef
Remove "or newer" reference to ensure that users know ACRN 1.2 requir…
2019-09-09 18:09:55 -04:00
lirui34
edbec46dcd doc: Add ACRN configuration tool tutorial
An offline configure tool is designed to configure the BOARD and VM configurations.
Here is the tutorial to tell people how to use it.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-09 11:03:04 -07:00
Deb Taylor
fd60bb0768 Add supported USB devices for WaaG and LaaG OSs
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-09 12:17:54 -04:00
lirui34
5d284c08f4 doc: Add three new glossaries
Add three new glossaries: "Hybrid Mode", "Partition Mode", "Sharing Mode".

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-09 17:00:37 +08:00
Deb Taylor
add89b51ec Remove "or newer" reference to ensure that users know ACRN 1.2 requires ONLY Clear Linux OS version 30690.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-06 18:44:17 -04:00
yunzha4x
4041275f78 doc: update Build ACRN from Source
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-09-06 12:02:50 +08:00
Geoffroy Van Cutsem
d324f79aee doc: add 'zlib1g-dev' to list of dependencies in Debian
Add 'zlib1g-dev' to the list of build tools and dependencies to be installed
in Debian in order to build the ACRN project.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-09-05 12:02:33 +02:00
Shiqing Gao
3729fa9451 doc: update Language Extensions in coding guidelines
- update Language Extensions in coding guidelines

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-09-02 13:37:16 +08:00
Deb Taylor
6ca4095d9c Update pages with missing links
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-28 09:37:15 -07:00
lirui34
48d06da743 doc: Add three known issues to the v1.2 release notes
Add three known issues to the v1.2 release notes.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-23 19:50:42 +08:00
Yan, Like
5dd07f7113 doc: remove "pincpu" option description
Update the document becase the "pincpu" option is removed.

Tracked-On: #3600
Signed-off-by: Yan, Like <like.yan@intel.com>
2019-08-22 13:06:28 +08:00
Victor Sun
1399f47987 doc: update partition desc for up2 board
modify partition desc table of up2 board to make it consistent with
launch uos script.

Signed-off-by: Lei Lu <leix.lu@intel.com>
Signed-off-by: Victor Sun <victor.sun@intel.com>
2019-08-22 09:10:38 +08:00
David B. Kinder
4d4c4e7b68 doc: remove modernizr.min.js
modernizr.min.js is no longer used by Sphinx's rtd theme and is causing
some browsers to have a noticable flash when pages are loaded. While we
can't easily remove it from the RTD theme, we can replace the script
with an empty file instead.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-16 15:36:46 -07:00
David B. Kinder
5b5efe7193 doc: add v1.2 to the release navigation picker
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-15 09:50:33 -07:00
David B. Kinder
7131b19f4a doc: remove references to 2.0 in intro
While we internally call the "new" ACRN architecture 2.0, it could be
confusing to users since we also are calling the upcoming release v1.2
and there is no 2.0 release yet.  Remove references to 2.0 in the
introduction.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-15 09:41:23 -07:00
lirui34
27b7cc23ea doc: Release Notes v1.2
Add release notes v1.2

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-15 09:23:40 -07:00
David B. Kinder
e77d1d7343 doc: add new scenario-based intro
Add the scenario configurations to the ACRN introduction.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-15 09:16:24 -07:00
Deb Taylor
a5647e9edf Content edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-08-14 21:09:49 -07:00
David B. Kinder
9144c56771 doc: incorporate new scenario-based hardware doc
Changing from just describing the supported hardware to a new hardware
support matrix based on the usage scenarios.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-13 18:30:25 -07:00
yunzha4x
bbf4df7bf7 doc: update Getting started guide for Intel NUC software setup
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-08-13 14:59:00 -07:00
yunzha4x
02073a2d72 doc: update Getting started guide for Intel NUC software setup
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-08-13 14:59:00 -07:00
yunzha4x
b06c84ba1f doc:update Getting started guide for Intel NUC software setup
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-08-13 14:59:00 -07:00
Lei Lu
bf1a162c3e doc: update Using SBL on UP2 Board
1. The origin clearlinux version 29070 in this doucment example is not
   workable with acrn latest code, update the clearlinux version.
2. Replace the sos_console_login.png with vm_console_login.png

Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-08-13 14:30:16 -07:00
Shiqing Gao
c3001e61a2 doc: add limitation for UEFI services
- add limitation for UEFI services

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-08-13 14:29:20 -07:00
Deb Taylor
13de9a4cf6 Formatting for new Hardware Support page 2019-08-09 16:58:20 -07:00
lirui34
70e1e8d154 doc: hybrid mode scenario introduction
Add introduction about how to enable hybrid mode scenario.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-09 16:32:13 -07:00
Li, Fei1
adbaaaf6cb hv: vpci: rename ptdev_config to pci_dev_config
pci_dev_config in VM configure stores all the PCI devices for a VM. Besides PT
devices, there're other type devices, like virtual host bridge. So rename ptdev
to pci_dev for these configure.

Tracked-On: #3475
Signed-off-by: Li, Fei1 <fei1.li@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2019-08-06 11:51:02 +08:00
David B. Kinder
70fdde4230 doc: add the SDC2 scenario doc into the navigation
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 17:24:54 -07:00
David B. Kinder
f0ecf8291f doc: incorporate scenario-based doc update
PR #3516 was submitted during a documentation reorganization and
resulted in merge conflicts with files that no longer exist.  We closed
that PR and opened this one with those changes applied to the right
files.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 15:38:23 -07:00
David B. Kinder
9580a2131b doc: apply edits to SDC2 scenario doc
Update merged PR #3463 with format and wording improvements.
(Not linked yet into the document navigation)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 12:59:00 -07:00
Tonny Tzeng
0ab14fab39 doc: adding guide to launch 2 Linux UOSes using SDC2 scenario
Tracked-On: #3462
Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
Reviewed-by: Fuzhong Liu <fuzhong.liu@intel.com>
Reviewed-by: Nanlin Xie <nanlin.xie@intel.com>
2019-08-02 10:27:02 -07:00
David B. Kinder
0085348f36 doc: update v1.0.1 release notes
Fix some wording, table formatting, and links to issues and commits from
the original PR #3515

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 10:23:13 -07:00
lirui34
3b00ab160e doc: release notes v1.0.1
Add release notes v1.0.1

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-02 09:55:19 -07:00
David B. Kinder
abd8b710a4 doc: improve CSS for home page grid
Update the ACRN logo size to remove specifics in the CSS.  (Grid images
should be ~100px high for the grid.)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 09:53:34 -07:00
David B. Kinder
a1cc860d5d doc: fix image proportions on home page for ie
The ACRN icon on the new graphical home page looked fine with firefox,
edge, and chrome browsers, but not on IE.  This PR fixes that

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 07:56:42 -07:00
David B. Kinder
cd232f4442 doc: fix broken links after content reorg
Home page "button" links needed to be manually updated (because of the
raw html usage) after content around.

Move partition mode docs from try to develop persona pages.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 07:34:25 -07:00
David B. Kinder
0d07dad5cb doc: additional doc navigation restructuring
Adjust doc navigation organization based on additional feedback.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 21:30:22 -07:00
David B. Kinder
2ccd652607 doc: simplify navigation with restored doc org
A few more tweaks to the site navigation since we moved the content back
to its original folder structure.

Remove the temporary "doc reorg in progress" banner.

Add reference to hardware in the "try" section.

Add link to the documentation home page in left nav pane.

Add additional redirects to handle external links to moved content.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 16:22:50 -07:00
David B. Kinder
e2d3653976 doc: continue doc restructuring
Changing the folder structure will cause too many broken links for
external references (from other sites). So, let's put the content back
where it was before the reorg, and instead use the new persona-based
navigation to point to documents in the original locations.

Also, introduce redirects for some documents that no longer exits.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 14:07:22 -07:00