Commit Graph

315 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
Jiayuan Yang 17d67247dc doc: revert Ubuntu24.04 support in GSG
Since Ubuntu24.04 requires 6.8 kernel(as shown in Ubuntu linux kernel
release lifecycle), we need to revert the ubuntu24.04 support in GSG to
suit our 6.1 acrn kernel.

Tracked-On: #8664
Signed-off-by: Jiayuan Yang <jiayuan.yang@intel.com>
2024-08-05 14:04:35 +08:00
Jiayuan Yang 8815a0aa6c doc: Specify elementpath and xmlschema version
In the newer version of elementpath and xmlschema, some camera releated
feature are missing, thus we need to specify them.

Signed-off-by: Jiayuan Yang <jiayuan.yang@intel.com>
2024-07-17 13:22:07 +08:00
Jiayuan Yang 0c10e8d38e doc: GSG update for ACRN v3.3
- Update ACRN kernel version to 6.1.80.
    - Update reference board to ASUS Mini PC PN64.
    - Update development computer and target system SOS to Ubuntu 24.04
      noble.
    - Change User VM image to Ubuntu 24.04 cloud image.
    - Add some necessary ACRN build tools.
    - Modify mem parameter in launch script xml to 4096M.
    - Modify the GRUB menu reference to suit the above changes.

Signed-off-by: Jiayuan Yang <jiayuan.yang@intel.com>
2024-07-17 13:22:07 +08:00
Kunhui-Li 8819e737ff doc: update the selected grub menu entry for booting ACRN and reboot command
Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2023-08-08 08:22:18 -07:00
David B. Kinder 4bb4733486 doc: update path to configurator debian package in GSG
For the v3.2 release, the new packaged configurator is at
https://github.com/projectacrn/acrn-hypervisor/releases/download/v3.2/acrn-configurator-3.2.deb

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2023-08-05 12:11:46 -07: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
Kunhui-Li ddb4e9c606 doc: update gsg for ubuntu 22.04.02 iso
update gsg for ubuntu 22.04.02 iso

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2023-08-03 14:53:44 -07:00
Min Yang c7907f244a doc: add "Linux" and "ACRN" to grub display in GSG
Add "Linux" before kernel version, and "ACRN" before acrn version.

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-12-22 15:39:20 -08: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
Min Yang 9d2e72f5ea doc: add kernel version to grub menuentry in GSG
1. add kernen version to menuentry "Ubuntu-ACRN Board Inspector"
2. add kernel version and acrn version to menuentry
   "Ubuntu with ACRN hypervisor"

Please refer to #8357(master) and #8358(release_3.2) for code change.

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-12-12 11:09:16 -08:00
Min Yang 1961718a6e doc: update grub menu set when reboot into ACRN in GSG
1. modify GRUB file /etc/default/grub
2. update GRUB menu after rebooting
3. update the UOS kernel

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-12-12 11:09:16 -08:00
David B. Kinder eca702ecf8 doc: update GSG with v3.2 changes
* install all Debian packages from /tmp (not ~/acrn-work)
* remove use of USB stick to copy files between dev and target (use scp)
* fix kernel version numbers (5.15.44 to 5.15.77)
* update parameters for debian_build.sh
* remove display of GRUB menu (ACRN now takes over target and
  automatically boots into hypervisor then Service VM

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-29 10:26:41 -08:00
Min Yang 03236c1de6 doc: update SGS and Sample App to match release 3.2
1. update grub item in SGS
2. update acrn kernel version
3. update file names

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-11-29 09:27:19 -08:00
David B. Kinder 23b36bae45 doc: update GSG to reflect release 3.2 changes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-24 12:00:56 -08:00
Min Yang 6634ab3ca1 docs: modify getting-started.rst
1.modify the board inspector name
2.add sudo before reboot (user: acrn)

Signed-off-by: Min Yang <minx.yang@intel.com>
2022-11-23 09:46:57 -08:00
David B. Kinder 2ae578eaaf doc: update GSG with corrections
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-21 23:00:39 -08:00
szhen11 f8ec216df7 doc: update GSG to use debuild to build ACRN packages
Signed-off-by: szhen11 <shuang.zheng@intel.com>
2022-11-21 22:30:29 -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
David B. Kinder 4f0bc815ac doc: update missed changes to Ubuntu 22.04
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-10-31 06:55:29 -07:00
zhangrouyu c9a836aed8 update ubuntu version from 20.04.5 to 22.04.1 in GSG document
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-10-28 06:57:08 -07:00
zhangrouyu 5a452e5e32 Create a requirements.txt for python package on GSG
Tracked-On: #8269
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-10-27 16:15:40 +08:00
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
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
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
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 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
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
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
David B. Kinder c88076d9ef doc: revert to not using requirements.txt in the GSG
GSG was recently updated to use a requirements.txt for python
dependencies, but that file doesn't exist in the repo at the v3.0 tag
the instructions say to use.  Revert to not use a requirements.txt until
we get this figured out.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-17 16:58:00 -07:00
zihengL1 b026238a69 config-tools: modified requirements.txt and update GSG
Modified requirements.txt in misc/config_tools/configurator
directory and add GSG requirements.txt inmisc/config_tools
directory.
Relevant python package installing steps in GSG.

Tracked-On: #7975
Reviewed-by: Junjie Mao junjie.mao@intel.com
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-08-16 17:20:23 +08:00
David B. Kinder a9bf1afc08 doc: fix order of steps in GSG setup
Edits preparing for using a requirements.txt introduced an error in the
step order (using a directory before it was created).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-15 20:25:40 -07:00