Commit Graph

678 Commits

Author SHA1 Message Date
Gao Junhao b5f77c0769 doc: add socket console backend for virtio-console
add new console backend of socket for virtio-console

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-16 20:37:08 -04:00
Geoffroy Van Cutsem 826094638a doc: Clear Linux "ACRN builder" container image
* Optimize the size of the Clear Linux container that can be used to build ACRN.
  This patch reduces the size of the container from approx. 10.8GB down to about
  3.8GB.
* Add tools required to build the ACRN documentation
* Add paragraph on how to build the ACRN documentation using Docker

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-10-15 07:36:11 -04:00
lirui34 44d2a56ba2 doc: fix missing words issue in acrn configuration tool doc
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-10-15 07:23:16 -04:00
Deb Taylor c7ecdf4764 Corrected number issue in GSG for ACRN Ind Scenario file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-10-14 17:47:37 -04:00
lidongwangx 051a8e4a45 doc: update Oracle driver install
Signed-off-by: lidongwangx <dongwangx.li@intel.com>
2019-10-14 17:42:31 -04:00
Yuan Liu b73b0fc285 doc: ioc: remove two unuse parts
Dependencies and Constraints, IOC Mediator Configuration parts are useless content
remove them.

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2019-10-14 17:37:10 -04:00
Geoffroy Van Cutsem 6f7ba36ea0 doc: move the "Building ACRN in Docker" user guide
Move the "Building ACRN in Docker" guide to the "Try using ACRN" section to be
more prominently visible. Reference it from the main "Build ACRN from Source"
user guide.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-10-14 17:33:20 -04:00
Geoffroy Van Cutsem 1794d994b6 doc: update doc generation tooling to only work within the $BUILDDIR
Modify the documentation Makefile (doc/Makefile) and scripts to only modify and
create content inside the $BUILDDIR folder.

The folders that were created inside 'doc/' previously are now all created
inside '$BUILDDIR/rst'. The '.gitignore' file has also been updated accordingly.

Tracked-On: #3686
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-10-14 17:26:48 -04:00
Lei, Lu 64742be820 doc: fix broken link in release notes 1.3
Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-29 14:59:33 +08:00
Lei, Lu 2dac1f02f4 doc: update build from source
1. Update build the hypervisor with XML file command.
2. Add "cd hypervisor" before "make defconfig BOARD=nuc6cayh"

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-29 09:53:59 +08:00
David B. Kinder 168d37d12f doc: add 1.3 to version menu
Update the version menu to include the 1.3 docs (and remove the 0.8)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-09-28 16:10:42 -04:00
Deb Taylor f489312e67 Doc: content edits for GSG for ACRN Ind Scenario
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-28 11:12:24 -04:00
lirui34 018fed2c21 doc: Add introduction for using Preempt_RT VM with Industry scenario
This tutorial is introducing how to build service vm, preempt_rt kernel and
industry scenario hypervisor; Update built kernel and launch the preempt_rt vm.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-28 04:54:37 -04:00
lirui34 9dbbaa1e7d doc: Release notes v1.3
Release notes v1.3

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-27 17:34:41 -04:00
Deb Taylor 96fc3fec10 Doc: content updates to ACRN Config Tool and Build frm Source
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-27 15:25:42 -04:00
lirui34 c17510d593 doc: update ACRN configuration tool document
- Remove the TBD parts;
- Add configuration tool UI app instructions;
- Update "Build from Source" for generating the hypervisor via configuration tool.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-26 08:53:13 -04:00
Lei, Lu c8ee9d98e8 doc: update acrn_ootb.rst
1. Update the Service OS VM default install disk to SATA, and Preempt-RT User
   VM default install disk to NVMe.
2. Update the Launch Preempt-RT User VM setup.

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-26 06:14:18 -04:00
Lei, Lu aa355af9a0 doc: update clearlinux version and acrn.efi name in GSG
1. update clearlinux version to 31090
2. update acrn.efi name to acrn.nuc6cayh.sdc.efi

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-26 06:09:35 -04:00
Deb Taylor dd1172ee63 doc: content updates to Install ACRN out of the box file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-25 19:24:42 -04:00
David B. Kinder df465cc1df doc: update robots.txt to exclude old docs
Exclude older documentation from search engines (< 1.0)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-09-25 14:24:16 -07:00
lirui34 7f42edcb0b doc: Use out-of-the-box image to boot ACRN RTVM
This tutorial describes how to generate, deploy OOTB Service VM
RTVM image so that all of the users are able to use ACRN, boot
RTVM immediately after installation without any configuration or
modification.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-25 15:36:45 -04:00
Geoffroy Van Cutsem 9c273cf33e doc: editorial tweaks to "Real-Time (RT) Performance Analysis on ACRN"
Editorial tweaks to the "Real-Time (RT) Performance Analysis on ACRN" document,
mostly to improve readibility, no technical content change.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-09-25 14:51:38 -04:00
Deb Taylor 7eb0dc1436 doc: content updates to RT perf tuning doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-25 09:39:20 -04: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