Commit Graph

22 Commits

Author SHA1 Message Date
Jiayuan Yang 069afc6519 doc: specify numpy version in sample application guide
histapp.py cannot run on numpy>=2, thus specify numpy<2 via pip install
command.

Tracked-On: #8664
Signed-off-by: Jiayuan Yang <jiayuan.yang@intel.com>
2024-08-05 14:04:59 +08:00
Jiayuan Yang 81529af1ca doc: update SOS to 22.04.4 in GSG and sample application guide
In this guide, each VM continue to use 22.04. SOS upgrade is done in
GSG(22.04.2->22.04.4).

Tracked-On: #8664
Signed-off-by: Jiayuan Yang <jiayuan.yang@intel.com>
2024-08-05 14:04:35 +08:00
Jiaqing Zhao 24af8011c9 doc: replace qemu-kvm with qemu-utils in sample application guide
The create_image.sh script uses qemu-img to create image files. Users
only need to install qemu-image in qemu-utils instead of the whole
qemu package.

Tracked-On: #8448
Signed-off-by: Jiaqing Zhao <jiaqing.zhao@linux.intel.com>
Reviewed-by: Junjie Mao <junjie.mao@intel.com>
2023-08-03 14:55:07 -07:00
Jiaqing Zhao 44bfb6a8df doc: update network configuration section
Launch script attaches guest network to bridge acrn-br0 by default,
while this bridge is not automatically created during installation.
This patch updates the documentation to guide users with the sample
bridge configuration in Getting Started Guide and Sample Application
Guide.

Tracked-On: #8448
Signed-off-by: Jiaqing Zhao <jiaqing.zhao@linux.intel.com>
2023-08-03 14:54:42 -07:00
Min Yang 1880ce82b3 doc: remove building the ACRN kernel for Service VM
delete building the ACRN kernel for the Service VM,
add some mention when building ACRN hypervisor,
and modify GRUB menuentry choice name.

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-12-12 11:09:44 -08:00
Min Yang da92fee03a doc: update sample-app version &command to match release_3.2
1. update hypervisor and kernel version to release_3.2
2. modify debian package (of ACRN hypervisor and tools) build command
3. delete iasl command lines (substitute: acpica-tools generate iasl in GSG)
4. remove use of USB stick to copy files from development computer to
   target (only use scp)
5. remove grub menu after reboot (it will boot automatically.)

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-12-12 11:09:44 -08:00
Xie, nanlin 6edc1a7715 doc: Upgrade RT kernel to 5.15 in sample app guide
Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2022-11-02 14:05:47 -07:00
zhangrouyu e5c1eafba3 doc: update changes to 22.04 on sample app guide
Tracked-On: #8269
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-11-01 09:56:07 +08: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
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 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
zhangrouyu 5a1e1fd6b4 supplement to revision
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-19 09:42:48 -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 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 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
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
David B. Kinder a7edf92ae4 doc: update sample app user guide
After review with engineering, we added material for showing what a
successful hmi_vm.img build ending looks like (and a hint of what to do
if it looks like the build failed.  Also added using a dhclient commmand
to the instructions in case the HMI_VM didn't get an IP address.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 18:03:40 -07:00
David B. Kinder 7c05b055d7 doc: fix typos in sample app guide
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 16:45:21 -07:00
David B. Kinder 0b938933db doc: add sample application user guide
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 15:36:29 -07:00