Commit Graph

584 Commits

Author SHA1 Message Date
David B. Kinder 983f4b90c2 doc: fix incorrect single back-tick usage
In markdown a single backtick around a term says to format it as
fixed-width text, e.g., `fixed-width text`.  The rst language uses
double back-ticks, e.g., ``fixed-width text``.

Fix misuses of single backtick in our documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-10-20 13:27:11 -07:00
David B. Kinder 6d1e24058f doc: update doc build tutorial
Update instructions for newer versions of the PyPI tools and doxygen.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-10-19 22:12:27 -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 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
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
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 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
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
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 f2dacfa30c doc: update rdt doc with real-time vCPU option clarification
Improve explanation of the Real-time vCPU option checkbox.

[External_System_ID] ACRN-9307

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-16 14:28:06 -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 cb91722dd5 doc: update rdt config tutorial
Add some clarification and updates for 3.1

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-09 14:26:25 -07:00
David B. Kinder ad0297ff02 doc: explain configurator error check and display model
We aluready updated the GSG to discuss how to find and address errors
when using the configurator (specifically doing a save scenario to check
for errors or to verify all errors were resolved). Add a description of
this error interaction model to the configurator tool documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-07-26 09:33:51 -07:00
Chenli Wei ccf80a5ec2 doc: update vUART tutorials
The current code assign COM2 to S5 feature as a commutation vUART, so
the COM2's IO port which value is 0x2F8 could not assign to another
vUART connection.

This patch add a note and modify the legacy vUART sample, change the
default IO port to 0x3E8 which was known as COM3.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
2022-07-19 10:25:34 -07:00
Kunhui-Li 69e1ec970c config_tools: update gpu passthru doc
add "i915.modeset=0" in kernel cmd line parameter for
allowing users to access a Ubuntu desktop.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-07-18 10:12:08 -07:00
Ziheng Li eb8bcb06b3 Update copyright year range in code headers
Modified the copyright year range in code, and corrected "int32_tel"
into "Intel" in two "hypervisor/include/debug/profiling.h" and
"hypervisor/include/debug/profiling_internal.h".

Tracked-On: #7559
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-07-15 11:48:35 +08: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
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
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
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
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
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 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 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
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
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
Reyes, Amy 9e2b9ffa58 doc: Remove outdated nested virtualization tutorial
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-24 11:21:26 -07:00
David B. Kinder 8af0e9b9ef doc: remove unreferenced images in doc tree
Over time we've deleted or change documents but didn't remove
unreferenced images.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-05-12 15:41:51 -07:00
hangliu1 3afb222d90 [config tool][doc]: remove old configurator
remove configurator in misc/config_tools/config_app, since
there is new configurator in misc/config_tools/configurator.
remove related document.

Tracked-On: #7466

Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
2022-05-12 15:42:26 +08:00
Reyes, Amy e1fc354c49 doc: Remove outdated RT tutorial
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-11 19:19:47 -07:00
Helmut Buchsbaum f5c63dd5ff doc: Adapt documentation to change of acrnlog log path
Tracked-On: #6688
Signed-off-by: Helmut Buchsbaum <helmut.buchsbaum@opensource.tttech-industrial.com>
2022-05-10 09:20:14 +08:00
Reyes, Amy c925d63dd9 doc: Copyedit upgrading_configuration.rst
- Grammatical and formatting cleanup

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-06 15:24:37 -07:00