Commit Graph

1558 Commits

Author SHA1 Message Date
David B. Kinder
4aa871effc doc: elementpath version must be 2.5.0 in the GSG
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-07-07 13:12:41 -07:00
Ziheng Li
1615c7346f doc: update upgrading_configuration.rst
Adjusted the order of <your scenario xml> and
--launch <your launch xml> when merged data from
the launch XML to the scenario XML.

Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-07-05 10:35:54 -07:00
David B. Kinder
21af4e459b doc: remove images no longer referenced
We deleted documents but didn't delete the images they used.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-30 22:23:41 -07:00
Kunhui-Li
c7ca50131c doc: update GSG picture
update GSG picture.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-06-29 22:27:47 -07:00
David B. Kinder
a90d8e5114 doc: fix gsg instructions for building the acrn-kernel
You need to be in the acrn-kernel directory in order to ``run make
distclean``  Also, remove mention of 6 VMs ...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 22:12:11 -07:00
David B. Kinder
deb377a586 doc: add link to configurator debian package in tag assets
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 18:07:20 -07:00
David B. Kinder
e2216bfaf2 doc: update release notes 3.0 year
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 17:40:02 -07:00
David B. Kinder
bac00cdec8 doc: add 3.0 to /latest header note
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 17:37:51 -07:00
David B. Kinder
becec0ab44 doc: add 3.0 release docs to menu choice
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 17:01:37 -07:00
David B. Kinder
5be506f5b2 doc: more edits for final 3.0 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 16:22:49 -07:00
David B. Kinder
b787f3ba7d doc: update acrn-kernel repo tag
acrn-kernel tag (for v3.0 hypervisor) should be acrn-v3.0

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 12:49:49 -07:00
David B. Kinder
beb27b3189 doc: update release notes for v3.0
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 12:28:57 -07:00
David B. Kinder
258f42440a doc: update GSG with Configurator debian download
Add instructions for downloading the configurator debian package and
installing it.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 12:28:38 -07:00
Kunhui-Li
74a67fbcd4 doc: update GSG
1. add link for ACRN configurator
2. update deb name.
3. update the patch of launch script.
4. update Python package dependencies.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-06-29 09:05:41 -07:00
fuzhongl
08654c8e38 Doc: ACRN on Qemu Update
Update the Service VM rootfs to Ubuntu 20.04

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com
2022-06-28 16:30:47 -07:00
Reyes, Amy
b594e1fbc7 doc: Update RDT/vCAT tutorial
* Merge RDT and vCAT tutorials
* Update overview, dependencies and constraints
* Update to match Configurator UI instead of manually editing XML files
* Remove architectural details and instead point to high-level design documentation

Tracked-On: #6081
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-28 16:28:09 -07:00
Reyes, Amy
a42997e9e0 doc: Add note about Configurator IVSHMEM/vUART address issue
-  The release v3.0 ACRN Configurator has an issue where you need to save the configuration twice to see the generated I/O or BDF address.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-28 15:44:45 -07:00
David B. Kinder
afa623ea06 doc: User VM guide
Create a new User VM OS guide with overview information about setting up
User VMs.  Link to separate standard and RTVM guide for details. Most of
these separate guides need updating to reflect the new ACRN configurator and
the development system/target system development model.

Update titles of existing "using XXX as user vm" to be consistent.

Begin update of ubuntu uservm doc for direction review.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-28 15:34:58 -07:00
David B. Kinder
bdfdc5c478 doc: update passthrough image in intro
Fix obsolete terminology and mention service VM/DM

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-28 11:00:05 -07:00
jackwhich
2c396fee97 doc: update release_3.0 fix issue list
update release_3.0 fix issue list

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-06-28 10:52:41 -07:00
Kunhui-Li
ee2b7567bd doc: update release notes for v3.0
This patch updates recommendations to upgrade from a prior ACRN version
for v3.0.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-06-28 10:52:41 -07:00
Reyes, Amy
cbe33ee750 doc: Update Configurator UI doc
- Update Debian file name
- Fix typos

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-28 10:47:37 -07:00
Reyes, Amy
0b95391357 doc: Update GVT-d tutorial
- Update overview, dependencies and constraints
- Update to match Configurator UI instead of manually editing XML files
- Remove architectural details and instead point to high-level design documentation

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-28 10:00:23 -07:00
David B. Kinder
cd60df6382 doc: rearrange "What is ACRN" for better presentation
What is ACRN introduction dives from the high level architecture
directly into the device model and device passthrough information.  It
gets pretty deep relatively quickly. Move the Static Configuration Based
on Scenarios section came earlier in the document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-27 22:31:25 -07:00
Reyes, Amy
26b2b8ca2a doc: Update GSG
- Update v3.0 tag for acrn-hypervisor
- Update virtio console description
- Update screenshots

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-27 22:30:53 -07:00
Reyes, Amy
0380f8e907 doc: Update IVSHMEM tutorial
- Update overview, dependencies and constraints
- Update to match Configurator UI instead of manually editing XML files
- Remove architectural details and instead point to high-level design documentation

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-27 20:45:20 -07:00
hangliu1
c72cc1916f doc: update some dm parameter
below parameters are obsolete, reserve the code for potential use
but remove the description in document.

amd_hostbridge
virtio-ipu
virtio-hyper_dmabuf
virtio-audio

Tracked-On: #6690
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
2022-06-27 18:32:48 -07:00
Qiang Zhang
81dc3b192e doc: Add launch script document
Add launch script document so that customers could understand how an
User VM is launched by ACRN Device Model.

As launch script is a user friendly tool to set Device Model parameters,
append the contents to Device Model Parameters chapter.

Tracked-On: #7801
Signed-off-by: Qiang Zhang <qiang4.zhang@linux.intel.com>
2022-06-26 18:51:35 -07:00
jackwhich
8c0070a531 doc: Update GSG/Hybrid HW pic
Update GSG/Hybrid HW pic and release_3.0 version

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-06-24 17:29:57 -07:00
Reyes, Amy
ad08ad87ea doc: Update vUART tutorial
- Update overview, dependencies and constraints
- Update to match Configurator UI instead of manually editing XML files
- Remove architectural details and instead point to high-level design documentation

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-24 11:22:26 -07:00
Reyes, Amy
452128a1ba doc: Remove OpenStack tutorial
- Outdated content, don't support OpenStack in v3.0

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-24 11:13:27 -07:00
Reyes, Amy
bcb82c0c4d doc: Update Config Overview
- Regarding post-launched VMs, update the messaging about static vs. dynamic. Dynamic is more about creating a VM at runtime per PR 7802, not changing the configuration of an existing VM at runtime.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-24 10:06:22 -07:00
David B. Kinder
5a2d4ac6c1 doc: update supported hardware doc with TGL Vecow system
Add v3.0 support for TGL Vecow system, starting at the maintenance level
of support.  Transition NUC11TNHi5 from maintenance to community level
support for v3.0.  Maintain all other boards at community level support.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-23 15:59:17 -07:00
Reyes, Amy
55e13ec91c doc: Update Configurator doc
- Update per comments in PR 7781

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-17 16:33:44 -07:00
Reyes, Amy
b34eb9ad1b doc: Update GSG HW pic and typo
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-17 16:20:32 -07:00
Reyes, Amy
1accaaf2bb doc: Update Configurator
- Add Configurator Debian package build steps that were removed from GSG
- Add description of error icon on parameters tabs
- Mention that working folder name should be meaningful

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-17 10:53:38 -07:00
David B. Kinder
6c35bb535d doc: update doc to use sudo with systemctl command
systemctl won't run as a normal Linux user, requires sudo

Also augment the description information

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-16 20:58:38 -07:00
Reyes, Amy
990ca9be06 doc: Update GSG
- Update Configurator UI steps
- Emphasize connecting USB devices
- Use release_3.0 branch until tag is created
- Fix typos

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-16 13:42:17 -07:00
Reyes, Amy
564aa5bde1 doc: Update Board Inspector
- Update prerequisites, commands, command-line options for v3.0 release

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-16 09:57:01 -07:00
Reyes, Amy
4e2ae9740f doc: Update Intro to ACRN Configuration
- Update to reflect configuration changes for v3.0

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-14 17:58:17 -07:00
Qiang Zhang
f941180fcb doc: add doc for required systemd services
"systemd-networkd" is required for acrn-dm to create bridge device.
Document it in GSG before acrn network deb package is ready.

Tracked-On: #7738
Signed-off-by: Qiang Zhang <qiang4.zhang@intel.com>
2022-06-13 21:41:07 -07:00
Reyes, Amy
200c554a5e doc: Update Configuration and Development Overview
- Align with new Configurator design, and use of Configurator instead of editing predefined XMLs

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-08 09:18:24 -07:00
Yuanyuan Zhao
b24ff3debf config_tools: merge python packages list for configurator
Merge python packages list into one 'requirements.txt'.
And modify related document.

Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-06-08 12:53:51 +08:00
Yuanyuan Zhao
f7d80168cd doc: GSG's python dependence
For config_tools use python to clear dirty files, add python dependence
while prepare development computer.

Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-06-08 12:53:51 +08:00
David B. Kinder
98a3d0d2cf doc: parameterize hidden config option doc generation
Add a configuration parameter for the xsltproc processing to decide
whether to include hidden options.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-07 17:44:04 -07:00
Reyes, Amy
6eeef69433 doc: Remove Launch Configuration Options
Removing Launch Configuation Options doc because all the launch script options are part of the new combined scenario XML and covered in Scenario Configuration Options doc.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-07 09:48:17 -07:00
Reyes, Amy
762b8dc849 doc: Create doc for Configurator UI
- This doc describes the Configurator UI for v3.0

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-02 10:43:48 -07:00
David B. Kinder
95995d167a doc: fix failure to make pdf output for project docs
The "make pdf" processing doesn't handle .svg files that were introduced
for the config option documentation.  Change these images to .png
instead.

The "make pdf" processing tools produce slightly different log output.
Tweak the "known issue" processing script (that removes messages from
the sphinx_build output for known issues that we can safely ignore.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-01 12:25:26 -07:00
David B. Kinder
df0f8ba997 doc: properly handle empty and skipped acrn:title
Fix how the config option doc scripts behave when encountering elements
with blank titles (used to remove extraneous headings in the
configurator UI).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-05-27 13:31:07 -07:00
David B. Kinder
a6a8f08854 doc: adjust views processing for schema documentation
The acrn:views processing for showing which tabs an option would display
on wasn't quite right when an element AND a parent both had a views
attribute (specifically when the parent had "basic, advanced" but the
element only had "basic" or "advanced").

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-05-25 14:00:21 -07:00