Commit Graph

656 Commits

Author SHA1 Message Date
lirui34
168306cd6a doc: Release notes v1.3
Release notes v1.3

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-26 06:58:35 +08:00
Deb Taylor
b16531257e doc: content updates for using SBL on UP2 board file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 20:23:10 -04:00
Deb Taylor
04dd9f97d2 doc: minor edits to using celadon as user os file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 19:41:25 -04:00
Deb Taylor
da89175bef doc: content updates to GSG for the Intel NUC
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 16:15:11 -04:00
lirui34
617a77d8fb doc: Add document of RT performance tuning.
Add document of RT performance tuning.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-24 09:57:07 -04:00
Lei, Lu
13b998f240 update using_sbl_on_up2 doc and create-up2-images.sh
1. Fix the broken link to dwonload UP2 Board BIOS
2. In Clear Linux 31030 the acrn.apl-up2.sbl name is changed to
   acrn.apl-up2.sbl.sdc.32.out, so we need to update the creaet-up2-imgages.sh
3. Command "swupd verify --install -m" has been superseded, use "swupd
   os-install -V" instead.

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-24 09:53:59 -04:00
lirui34
01a1aeb69f doc: Add note to use a stable Celadon source tree
So far the patches are only suite for Celadon Android 9.
Need to specify the Android 9 repo branch to apply patches and
build Celadon image.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-24 09:53:02 -04:00
Lei, Lu
d1796d7565 doc: update gsg and acrn_quick_setup.sh
1. From Clear Linux 31030, we could use kernel-iot-lts2018-sos kernel
   command line as Service OS kernel command line directly, so update
   the setps and codes to set the Service OS kernel command line.
2. Command "swupd verfiy" and the flag "-m" is superseded, use "swupd
   repair" and the flag "-V" instead
3. As UOS is launched by OVMF, the old steps and code to set up UOS does
   not work on Clear Linux 31030, update its related steps and code.
4. Update install Clear Linux steps.
5. Fix some small issues.

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-24 09:48:24 -04:00
Geoffroy Van Cutsem
76da81370b doc: tweak vUART tutorial for improved rendering
Tweak the "vUART configuration" tutorial to fix a few typos and change some
formatting to improve its readability.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-09-24 08:47:07 -04:00
Deb Taylor
698ec4c4f4 Doc: Update image and text in Virtio-i2c doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 08:01:27 -04:00
Deb Taylor
960c508bab Doc: Initial vuart configuration doc and images--4979
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 07:10:51 -04:00
Deb Taylor
9e759bcfa0 Initial virtio i2c doc and images.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-23 11:13:30 -04:00
Geoffroy Van Cutsem
f5c8fbb281 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 09:10:32 +08:00
Deb Taylor
32a75af1ea New tutorials for running deb or ubunt as user vms
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-17 14:56:18 -04:00
Mingqiang Chi
60adef33d3 hv:move down structures run_context and ext_context
Now the structures(run_context & ext_context) are defined
in vcpu.h,and they are used in the lower-layer modules(wakeup.S),
this patch move down the structures from vcpu.h to cpu.h
to avoid reversed dependency.

Tracked-On: #1842
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Reviewed-by: Jason Chen CJ <jason.cj.chen@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2019-09-16 14:51:36 +08:00
Deb Taylor
6045a5e54c Intitial doc for Running Debian as a Service VM
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-12 22:07:09 -04:00
Deb Taylor
64805b51b1 Language edits to the Building ACRN in Docker tutorial
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-12 12:00:33 -04:00
Lei, Lu
2628868ae0 doc: add build acrn in docker tutorial
Add a tutorial about how to build acrn in docker.

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-12 10:36:39 -04: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