Commit Graph

1662 Commits

Author SHA1 Message Date
David B. Kinder
f8f1d22645 doc: fix missing numbered-step icon
Sphinx version 5 generates <section> instead of <div> for
section headings.  This throws off the custom CSS style for numbered
steps so the number icon wasn't showing up.  Tweak the custom CSS to
look for both <section> and <div> with class=numbered-step
to handle Sphinx 4 and 5-generated content.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2023-01-19 17:09:12 -08: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
e41d6c1c9e doc: add 3.0.2 release notes to master branch
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-22 10:31:38 -08:00
Yonghua Huang
37750a5a48 doc: update asa.rst for v3.0.2 release
Update security advisory for v3.0.2 release.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-22 09:26:35 -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
David B. Kinder
9ac6c31c3b doc: add tutorial for enabling multiple displays
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-16 07:43:59 -08:00
David B. Kinder
439fc12246 doc: update doc build requirements
Verified that the newly released RTD theme is OK to use with the doc build process,
so update the requirements.txt with that and tweak the acceptable docutils versions.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-11-02 14:08:06 -07: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
Junjie Mao
c526cbebf1 doc: handle anonymous complex types in XML schema
The schema of scenario XMLs uses both named and anonymous complex types,
but the configdoc.xsl today only works for named complex types. That causes
improper rendering of config items related to virtio devices (whose schema
uses anonymous types) as well as wrong applicable VM icons which states
that virtio devices apply to not only post-launched VMs but also
pre-launched and service VM, which does not make sense.

This patch improves configdoc.xsl by adding support of anonymous complex
types so that they are walked through in the same way as named ones.

Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2022-10-27 18:26:54 -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
David B. Kinder
893fbfec78 doc: fix views and applicable VMs label handling in config option doc
Custom attributes in the XML schema, such as `applicable-vms` and `views`,
are designed to recursively inherit those of the parent. Thus, the
effective attribute of an element should be derived by its lowest ancestor
that has that attribute explicitly defined. Looking up only one level would
not be sufficient.

This patch updates the `configdoc.xsl` to derive the effective attributes
properly so that icons in the generated doc properly reflects what is
specified in the schema. Addresses ACRN-7347

Signed-off-by: Junjie Mao <junjie.mao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-10-26 07:52:26 -07:00
David B. Kinder
991f55598b doc: grammar fixes
fixing some grammar issues in documentation

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-10-26 07:43:56 -07:00
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
David B. Kinder
38f8097b54 doc: update doc build tools for Ubuntu 22.04 and Sphinx
Update known-issues processing and tweak conf.py and requirements.txt
(for PyPI package versions) to handle a broader version of
doc-generation tools (sphinx, breathe, docutils, etc.).  This should
let us move to Ubuntu 22.04 while maintaining doc-build compatibility
with older tool versions available with Ubuntu 20.04 (doxygen in particular).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-10-19 09:37:39 -07:00
David B. Kinder
4b6c782726 doc: prep for Ubuntu 22.04
These changes are compatible with both the Ubuntu 20.04 and 22.04
documentation build processes.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-10-18 15:20:04 -07: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
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