Commit Graph

1634 Commits

Author SHA1 Message Date
zhangrouyu ee0a1b0f1c doc:Modify the tqdm package problem in the GSG document
We have real fix in PR#8222, thus remove the workround in document.
delete the command: sudo pip3 install tqdm

Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
Tracked-On:8155
2022-10-18 15:04:11 -07:00
zhangrouyu 6a1acd7b5e revision the GSG document of ubuntu kernel version
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-30 09:07:38 -07:00
Reyes, Amy e354ed3061 doc: Editorial changes to sample app guide
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-29 08:14:52 -07:00
Reyes, Amy 3deb327177 doc: Editorial changes to Configurator doc
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-28 15:52:49 -07:00
Reyes, Amy 31331a6390 doc: Editorial changes to DM params doc
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-28 08:33:28 -07:00
Reyes, Amy 4a7c81a449 doc: Fix typos in interrupt hld
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-27 16:13:38 -07:00
Reyes, Amy fcc8edac38 doc: add 3.1 to /latest header note
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-26 10:07:26 -07:00
Reyes, Amy 9f52c5c32a doc: Update v3.1 release notes
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-26 10:04:24 -07:00
Reyes, Amy 39cdf6f7a6 doc: add 3.1 release docs to menu choice
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-23 22:01:45 -07:00
Reyes, Amy 88c78c9e43 doc: Editorial changes to v3.1 release notes
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-23 14:42:20 -07:00
Reyes, Amy ed9baa64ea doc: Update S5 tutorial
- Update the S5 tutorial to align with new template and GSG scenario

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-23 09:37:29 -07:00
zhangrouyu 76d8fea2ff doc: Upgrade the information about Release Notes
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-23 08:26:22 -07:00
zhangrouyu 4844ae4772 Update the version infomation of sample app guide
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-23 08:18:47 -07:00
Reyes, Amy dc6fccfa0d doc: Editorial changes to hypercall hld
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-21 09:18:37 -07:00
Junjie Mao 245951f8ea doc: add hypercall ABI in the HLD
The application binary interface (ABI) is an important aspect of
hypercalls. But unfortunately it is not yet defined anywhere in the current
HLD.

This patch adds the current ABI specification to the hypercall section of
HLD.

Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2022-09-21 08:16:56 -07:00
Reyes, Amy c6cbd6b6df doc: Update sample app
- Minor editorial changes
- Improve image quality

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-20 13:18:09 -07:00
Reyes, Amy 42be836301 doc: Minor editorial update to GVT-d tutorial
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-19 10:21:55 -07:00
zhangrouyu 67a161c13e gtvd
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-19 10:04:33 -07:00
zhangrouyu 5a1e1fd6b4 supplement to revision
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-19 09:42:48 -07:00
Reyes, Amy 96baec68c0 doc: Minor GSG edits
- Minor editorial changes
- Improve image quality
- Delete unused image

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-16 15:38:11 -07:00
zhangrouyu 34776484df GSG document revision 2022-09-16 13:28:14 -07:00
Reyes, Amy 98886ae2a0 doc: Update CPU sharing tutorial
- Clarify blocked state

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-16 09:12:41 -07:00
Reyes, Amy d579a0be47 doc: Improve image quality - configurator
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 15:22:33 -07:00
Reyes, Amy 78609b0ba1 doc: Improve image quality - ivshmem
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 11:47:09 -07:00
Reyes, Amy d7404bb976 doc: Improve image quality
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 11:34:59 -07:00
Reyes, Amy 2238452c1d doc: Improve image quality
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 11:20:48 -07:00
Reyes, Amy eda363f28a doc: Update CPU sharing tutorial to match v3.1 Configurator
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 08:11:40 -07:00
Reyes, Amy 38294e6b81 doc: Minor edit to RDT tutorial
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-14 17:24:11 -07:00
Reyes, Amy 7c7326e166 doc: Update supported HW
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-14 17:23:54 -07:00
Reyes, Amy 13aa50b508 doc: Remove note about v3.0 Configurator issue
The issue has been fixed in v3.1.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-14 09:47:42 -07:00
Chenli Wei 71ccd8a5e5 doc: update vUART tutorials
The ACRN Configurator release 3.1 following the release 3.0 logic, so
the COM2 still used for S5.

This patch modify the "The release v3.0 ACRN Configurator assigns… …"
to "The release v3.0+ ACRN Configurator assigns… …" and refine a typo
issue.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@intel.com>
2022-09-14 09:47:14 -07:00
hangliu1 e5d45b94c9 [doc]remove some decription about hvlog
to avoid misleading for users, delete the description about
hypervisor relocation disabling, since it is not officially
supported by ACRN configurator now.

Tracked-On: #8133
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
2022-09-13 17:20:22 -07:00
Reyes, Amy 3eea8d6da8 doc: Update references to scenario options doc
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-06 11:13:33 -07:00
David B. Kinder 212574a666 doc: clarify sample app instructions
Clarify commands that needed to be run on the target and not the dev
system

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-30 15:59:03 -07:00
David B. Kinder 2df52d9078 doc: v3.1 release notes draft update
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-30 11:57:56 -07:00
David B. Kinder 3b02e2ebe2 doc: add a doc helper script
changed-docs.sh (and the accompanying awk script) shows docs changed
between a previous release branch and the current master branch, in a format that
can be used for the releae notes (a list of :ref: items).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-30 11:45:35 -07:00
David B. Kinder 2eb6dc4e10 doc: update 3.1 release notes draft
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-30 09:56:40 -07:00
David B. Kinder 42d2ef6d5f doc: update 3.1 release notes draft
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-29 20:30:51 -07:00
David B. Kinder 478a550ba6 doc: tweak CSS to outdent numbered step icons
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-27 17:21:35 -07:00
David B. Kinder d96656e4ad doc: fix typo in GSG
missing a trailing backslash on a command continuation

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-26 14:22:37 -07:00
zihengL1 b16fcda6b5 config-tools: modified requirements.txt and update GSG
Modified misc/config_tools/configurator/requirements.txt
and misc/config_tools/requirements.txt. Updated getting-started.rst
and acrn_configurator_tool.rst.

Tracked-On: #7975
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-08-26 16:56:16 +08:00
David B. Kinder 8ac707d244 doc: draft of 3.1 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-25 15:10:21 -07:00
David B. Kinder a1281b9085 doc: update GSG and sample app guide
* Fix missing /build folder in copy command in GSG
* Mention USB stick needs formatting for large files when used for the
  sample app (but we'll put that into GSG too).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-25 15:01:46 -07:00
David B. Kinder b7e4c4baa7 doc: fix typo in sample app doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-25 07:48:15 -07:00
David B. Kinder a8dd662635 doc: update sample app doc to use sudo
Previously the sample apps needed to be run as root, but with a recent
update they could be run as a normal (acrn) user.  Update the sample app
to use sudo for running these sample app components in case the user
doesn't login as root.  Also, split running the background app and the
foreground app into two commands to eliminate some confusion.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-24 20:46:35 -07:00
David B. Kinder 2addfe9ca1 doc: update GSG to include scp instructions
Make the GSG more consistent with the sample app doc and show how to use
scp to transfer files between the dev and target machines.

Also add a mention of the sample app guide at the end of the GSG.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-24 17:27:00 -07:00
David B. Kinder 5a8339be25 doc: update sample app guide
Address comments from DX reviews, and update the cyclictest histogram
output (improvements from PR #8026)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-22 16:47:13 -07:00
Zhang Wei 31f92eba63 doc: Add a python package in GSG
The Getting Started Guide specifies that we need to install the Python packages lxml, xmlschema, and defusedxml.
However, a make clean involves the execution of the Python script manager.py. This script imports the package requests.py, which might not be installed if the developer follows the Getting Started Guide.

Add requests follow this command in GSG.
sudo pip3 install "elementpath==2.5.0" lxml "xmlschema==1.9.2" defusedxml tqdm requests

[External_System_ID] ACRN-9144
Tracked-On: #8029
Signed-off-by: Zhang Wei <wei6.zhang@intel.com>
2022-08-22 10:03:30 -07:00
David B. Kinder f4ef01dc2c doc: update sample app guide
* Fix preempt-rt patched kernel label on wrong VM
* Fix path copying hmi_vm.img and rt_vm.img (they're not in ~/acrn-work
  directory)
* Rename png images to avoid potential conflicts with other images on the
  system.
* Fix Ubuntu wecome message text after logging into RT_VM

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-19 11:39:54 -07:00
Liu Long b9c4d2622c ACRN: Doc: Modify the SampleApplication document
1. Add the move iasl binary to the /usr/sbin directory.
2. Modify login RT_VM user to root user.

Signed-off-by: Liu Long <long.liu@linux.intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 21:31:51 -07:00