Commit Graph

598 Commits

Author SHA1 Message Date
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
David B. Kinder 11d4f4159f doc: Reorganize documentation site content
Take the existing ACRN technical documentation and reorganize its
presentation to be persona and use-case based, in preparation for adding
new scenario/use-case based architecture introduction and getting
started documents.

Introduce a more graphical home page and theme color tweaks.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-31 18:29:22 -07:00
lirui34 52618d0a23 doc: Update WaaG tutorial launch script and OVMF binary
Change WaaG launch script to the default ``launch_win.sh``,
and also provide one OVMF.fd binary in order to launch WaaG.
Change SOS / UOS to Service VM / Guest VM.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-07-31 13:08:05 -07:00
Yang, Yu-chu d1c8a514f6 doc: Add ovmf option description
Added ovmf NV storage writeback option "w" description and usage example.

Signed-off-by: Yang, Yu-chu <yu-chu.yang@intel.com>
2019-07-29 20:36:43 -07:00
David B. Kinder 8ee1615e51 doc: fix issues from moving tools to misc/tools
PR #3483 cleaned up the project root folder and moved stuff that was in
/tools into a new /misc folder.  There were a few references to
the old /tools folder missed in that update, addressed in this PR.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-29 14:23:04 -07:00
Deb Taylor f44517c772 final edits 3
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor 879d01319f final edit 2
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor 1ccb902048 final edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor d485ed86c0 edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor 28e49ac183 more edits 2019-07-29 13:58:41 -07:00
Deb Taylor cc2714eee9 edits from David review
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor 7ee02d8eb0 Image resize
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor 87162e8b3e Making three images even smaller
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor 42960ddcc8 Adjust picture size for SGX
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor d0f7563d89 Corrected images and formatting
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
deb-intel ce7a126f7e Added 3 SGX images 2019-07-29 13:58:41 -07:00
Deb Taylor 01504ecf93 Initial SGX Virt doc upload
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Terry Zou a9c38a5cfb HV:Acrn-hypvervisor Root Directory Clean-up and create misc/ folder for Acrn daemons, services and tools.
This patch is to clean-up acrn-hypervisor root directory, targt only 5 folders under acrn-hypervisor:1.hypervisor,2.devicemodel,3.misc,4.doc,5.build

Tracked-On: #3482
Signed-off-by: Terry Zou <terry.zou@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2019-07-29 22:58:24 +08:00
David B. Kinder 9fef51abf9 doc: organize release notes into a folder
Unclutter the main doc folder by putting all the release notes
into a separate folder.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-24 09:47:24 -07:00
Lei Lu 0887eecde8 doc: remove deprecated sos_bootargs
SOS bootargs is specified in vm_configurations.h in different scenarios.
  The files in devicemodel/samples/<board>/sos_bootargs_*.txt are removed.
  remove deprecated sos_bootargs in create-up2-images.sh

Tracked-On: #3443

Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-07-23 17:41:29 -07:00
yunzha4x 2e79501e4d doc:udpate using_partition_mode_on_nuc nuc7i7bnh to nuc7i7dnb
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-07-23 09:46:09 -07:00
Conghui Chen 87558b6f98 doc: remove vuart configuration in nuc and up2
As the vuart config option is not support anymore, remove it.

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2019-07-19 12:13:11 -07:00
lirui34 e729b657c0 doc: Add ACRN tag or Clear Linux version info for some tutorials
Neither ACRN tag nor Clear Linux version is specified in some tutorials.
Declare those information for those tutorials.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-07-19 12:12:23 -07:00
lirui34 ffa7f80544 doc: Add tutorial to learn to sign binaries of a Clear Linux image.
This tutorial will describe steps to sign binaries of
a Clear Linux image that allows user to launch VM
throught the secure boot enabled OVMF.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-07-19 12:10:23 -07:00
David B. Kinder be44e138fd doc: update WaaG doc
Update batch script documentation and add reference to source of
material.  Also some grammar cleanup in a few places.

Include an updated install_by_vga_gsg.tar.gz with an updated script with
copyright/licensing added.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-19 12:09:08 -07:00
David B. Kinder ecc472f9b4 doc: fix format in WaaG document
Update WaaG document with Windows (upper case) and step numbering.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-17 09:35:32 -07:00
ruix.li 7990f52f59 doc: Add introduction of using Windows Guest OS
Add introduction of using Windows Guest OS

Tracked-On: #3341
Signed-off-by: ruix.li <ruix.li@intel.com>
2019-07-17 09:10:10 -07:00
yunzha4x be586b4959 doc:Update Getting started guide for Intel NUC
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-07-15 13:46:54 -07:00
ruix.li 1aef5290ea doc: Add platform sos info and GUI screenshots against Celadon Guest OS
Add sos info and Celadon OS GUI screenshots for the Celadon UOS tutorial.

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-07-10 20:10:16 -07:00
David B. Kinder 44fc5fcbf0 doc: fix typos in rtvm workload design doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-09 17:28:29 -07:00
Jason Chen CJ 503b71a16e doc: add guideline for RTVM workload design
a quick guideline document help RTOS designer/developer to design
RT workload based on RTVM

Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-07-09 17:25:30 -07:00
ruix.li 93659f0160 doc: Add introduction of launching Celadon User OS
Add introduction of launching Celadon User OS

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-07-09 15:48:16 -07:00
Xiangyang Wu 4c3f298ed6 doc:add more description about application constraints
In the current design guidlines, it is not clear about
how to check application constraints and how to record
them.

Add description about it is optional to do error checking
for application constraints during hypversisor boot time;
Add reference about how to record design assumptions.

Signed-off-by: Xiangyang Wu <xiangyang.wu@linux.intel.com>
2019-07-01 12:15:13 -07:00
David B. Kinder 2376b3af5c doc: update doc version menu
Update the /latest/ (master) version of the docs to provide the menu
choice for the v1.1 release.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-27 14:56:41 -07:00
ruix.li 680edd1d3c doc: Update acrn-manager README and QoS introduction
Modify 'launch_UOS.sh' to 'launch_uos.sh' and provide an example for
the script which is support '-C' option.

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-06-27 14:41:06 -07:00
ruix.li 5bee933885 doc: Add v1.1 release note
v1.1 release note

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-06-27 14:13:29 -07:00
Kaige Fu 217145e33b Doc: Update acrn-shell.rst for new 'version' cmd
This patch updates acrn-shell.rst for new 'version' cmd.

Tracked-On: #3310
Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2019-06-23 21:57:12 -07:00
ruix.li f145cd490c doc: Instruction of enabling ACRN-DM QoS.
Add instruction of enabling ACRN-DM QoS based on runC container.

Tracked-On: #3131
Signed-off-by: ruix.li <ruix.li@intel.com>
2019-06-19 09:34:08 -07:00
Lei Lu 030e7683ad doc: add systemd-networkd-autostart bundle in APL GSG
Clear Linux changed from systemd-networkd to NetworkManager as default
"network manager", We need to install "systemd-networkd-autostart"
bundle to enable systemd-networkd to create ACRN network bridges and Tap
devices.

Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-06-17 13:54:02 -07:00
David B. Kinder 86d3065de1 doc: tweak doxygen precondition label
The doxygen-collected API information about function preconditions has a
uninspired title of "pre".  This change tweaks that to be
"preconditions" in the generated HTML output by editing the generated
xml output before it is processed by Sphinx/Breathe.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-17 11:19:44 -07:00
Li, Fei1 9960ff98c5 hv: ept: unify EPT API name to verb-object style
Rename ept_mr_add to ept_add_mr
Rename ept_mr_modify to ept_modify_mr
Rename ept_mr_del to ept_del_mr

Tracked-On: #1842
Signed-off-by: Li, Fei1 <fei1.li@intel.com>
2019-06-14 14:40:25 +08:00
David B. Kinder cf6d6f1678 doc: remove (outdated) primer documents
The ACRN primer has be replaced by an updated set of ACRN High-Level Design
documents.  Remove the primer (and images), and replace a link to the
graphics mediation section (from API documentation) to the corresponding
section in the APL GVT-g document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-13 12:34:11 -07:00