Commit Graph

1107 Commits

Author SHA1 Message Date
Geoffroy Van Cutsem
686a1173f8
doc: fix typo in docbuild.rst
Fix a typo in the `docbuild.rst` file.
2021-01-04 10:49:29 +01:00
David B. Kinder
b74b4cd53d doc: upgrade doc-build tools
Update the documentation for how to build ACRN documents
(tutorial/docbuild.rst) and the scripts/requirements.txt that lists the
tested configuration of python tools being used.

Previous merged commits have already been made to handle doc builds with
the previous (2.3 documented configuration and the new v2.4
configuration.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-31 14:56:17 -08:00
David B. Kinder
c0707ab361 doc: prep for upgrading doc build tools
Update known-issues list to eliminate known warnings for duplicate
declaration warnings because of breathe/sphinx upgrades.

Update conf.py to check sphinx version and use appropriate way to
include extra javascript and css files depending on the version.

Both of these changes will allow the old and new doc tools to not show
unanticipated warnings or errors and allow for a smooth upgrade to the
CI system (and contributors local doc builds).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-31 13:04:27 -08:00
David B. Kinder
69b207ac6a doc: spelling fixes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-28 15:02:06 -08:00
David B. Kinder
33901fd287 doc: fix formatting in windows as UOS doc
code-block content wasn't indented in a recent change so wasn't included
in the code-block formatting

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-24 11:07:28 -08:00
fuzhongl
703e0e2d52 Doc: update Debian and Ubuntu as the User VM
Pipe info isn't needed for IDV solution; so remove this part in
the document.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-12-23 09:27:19 -08:00
David B. Kinder
35aba4ff21 doc: remove stray x attrib on png and rst files
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-21 09:57:19 -08:00
Yonghua Huang
df5e0bfe00 doc: remove exec attribute for 'acrn-secure-boot-with-grub.rst'
Remove 'x' attribute of this file and one more minor fix.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-12-21 09:45:43 -08:00
Geoffroy Van Cutsem
6fa0cb3758 doc: fix 'cp' command in instructions
Fix the 'cp' operation in the instructions explaining
how to build the kernels.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-21 09:37:54 -08:00
fuzhongl
2c5b7fcde8 Doc: update WaaG image creation with GVT-d GOP
Since GVT-g isn't enable for new platform (i.e TGL EHL CFL),
update the doc about using GVT-d GOP to create WaaG image.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com
2020-12-21 09:37:12 -08:00
Geoffroy Van Cutsem
070be0aa99 doc: specify the version of 'sphinx-tabs' to install
Specify the version of 'sphinx-tabs' to be installed in order
to be able to build the documentation. Without this, the latest
is installed but is incompatible with 'sphinx==1.7.7' as specified
in our doc/scripts/requirements' file.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-21 09:35:18 -08:00
David B. Kinder
52d33f067e doc: tweak to copyright footer
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-18 08:40:31 -08:00
David B. Kinder
61e5957129 doc: automate copyright year footer
Automatically update the copyright year on the page footers to be
2018-[current_year] when generating documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-17 10:59:57 -08:00
Steve Winslow
bdcfb5c83b doc: add ACRN lockup logo to README
As part of the trademark registration for ACRN, it is helpful to
ensure that the logo is displayed on the same page from which the
ACRN code can be downloaded.

This PR adds the logo and updates the README file to display it.

Tracked-On: #5601

Signed-off-by: Steve Winslow <steve@swinslow.net>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-15 10:36:42 -08:00
ChenYing Kuo
ead26799ff Small updates to ROScube-I Installation Guide
* Add newline before `sudo reboot` in User VM section.
* Add `cd ~/acrn/tools/` before downloading script in User VM section.

Signed-off-by: ChenYing Kuo <chenying.kuo@adlinktech.com>
2020-12-10 09:23:49 -08:00
Geoffroy Van Cutsem
9264aeb77d doc: small updates to the GSG
Small updates to the Getting Started Guide:
* Add a missing command
* Add a note for the Grub configuration
* Make the 'blkid' hint consistent with the environment

Tracked-On: #5594
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-10 09:21:54 -08:00
David B. Kinder
2571314d77 doc: add ROScube GSG
Adding a new GSG contributed by ADLINK for installing an ACRN Industry
Scenario on their ROScube-I system.

Signed-off-by: ChenYing Kuo <chenying.kuo@adlinktech.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-08 11:08:58 -08:00
Yonghua Huang
d5bf1a76ff doc: update acrn secureboot enablement
- Format some section title
 - Add one more section.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-05 12:05:27 -08:00
Yonghua Huang
914ac534c0 doc: update HLD of HV-Land Ivshmem
Add a figure for HLD of HV-land doorbell design.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-12-05 11:25:31 -08:00
David B. Kinder
8838f0e661 doc: tweak to 2.3 release notes
Added a couple of missing documents in the "changed doc" list, and fixed
spelling of passthrough

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-03 09:23:00 -08:00
David B. Kinder
dd05d7417a doc: update doc version selector for v2.3
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 17:46:23 -08:00
David B. Kinder
ef36eacb55 doc: release notes tweaks for v2.3
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 17:30:14 -08:00
fuzhongl
2e947496c2 Doc: release_notes_2.3 update
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-12-02 17:13:45 -08:00
David B. Kinder
5cd9eb43a9 doc: update v2.3 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 09:43:05 -08:00
Shuang Zheng
b87814ba36 doc: update the doc to setup openstack with ACRN
update ACRN version, update kernel boot args, and fix the issue in
the steps to set up libvirt.

Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 09:12:48 -08:00
Yonghua Huang
4759735c99 doc: Setup secureboot with GRUB
Add guide to enable grub secure boot on ACRN.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 08:59:52 -08:00
fuzhongl
124752fcf7 Doc: Update GSG and Build ACRN from Source for v2.3
Update Getting Started Guide for ACRN Industry Scenario with Ubuntu Service VM;
and Getting Started Guide for ACRN logical partition mode.
Also update Build ACRN from Source for EFI related part since it is
removed form v2.3

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com
2020-12-02 08:52:50 -08:00
Peter Fang
3db34b3164 doc: add documentation for graceful system shutdown
Tracked-On: #5411
Signed-off-by: Peter Fang <peter.fang@intel.com>
2020-12-02 08:51:11 -08:00
David B. Kinder
ad8a0cf737 doc: doc cleanup for v2.3 release
Remove some stray Clear Linux references, document labels, and update
the known issue filter patterns.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-01 15:37:06 -08:00
Yonghua Huang
eb4f335dab doc: update 'enable_ivshmem'
Add notification (doorbell) usage for ivshmem devices.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-01 09:12:29 -08:00
Yonghua Huang
a95e019045 doc: update 'asa.rst' for 2.3 release
update fixed security issue for 2.3 release.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-01 09:04:38 -08:00
Tao Yuhong
e8c20e7a63 Doc: pci-vuart-guide
update tutorials/vuart_configuration.rst, add pci-vuart guide

Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-30 18:35:19 -08:00
Yang,Yu-chu
73cd9e939c doc: update configuration tool description of vuarts
Acrn introduces pci based vuart. Update the existing vuarts and add the
pci based vuart description

1. rename existing vuarts to legacy_vuart
2. add console and communication vuarts general desciption
  - the console vuart is similar to legacy_vuart0 but only contains subtag "base"
  - the communication vuart is similar to legacy_vuart1 but only contains subtags
    "base", "target_vm_id" and "target_uart_id"

Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-30 18:14:02 -08:00
David B. Kinder
b028e9f9a3 doc: add v2.3 release notes draft
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-30 17:18:31 -08:00
Geoffroy Van Cutsem
36e42c9fdf doc: correct typo (missing space)
Add missing space in the document describing how to use Ubuntu as a User VM OS.
2020-11-23 17:02:13 -08:00
Geoffroy Van Cutsem
3ae00e1b22 doc: correct 'gvtg' parameters for acrn-dm
Correct the GVT-g parameters description in the 'ACRN Device Model parameters'
document. The order was the wrong way around.

Tracked-On: #5528
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-11-23 00:08:07 -08:00
Yang,Yu-chu
dc86cd8bff doc: update the steps of enable ivshmem
To enable the hv_land ivshmem for post-launched vm, the lanch script
needs to be cofigured accordingly.

Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
2020-11-23 00:07:12 -08:00
David B. Kinder
f2546384c8 doc: fix breathe config for C vs CPP
Breathe and doxygen work best for C++, but we're using C.  This shows up
as API documentaiton having a C++ flavor (modules and classes) instead
of the expected C flavor.  We really need to upgrade the versions of
doxygen and breathe to newer versions, and this configuration tweak
prepares for this.  (It will need CI coordination to update these tools,
but the changes in this PR are compatible with the current older tools.)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-23 00:06:01 -08:00
fuzhongl
bb4fcae1b8 Doc: update document to remove CL Service VM dependency
Some document refer Clear Linux as Service VM; update them
to Ubuntu Service VM.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-11-23 00:02:58 -08:00
Peter Fang
121e015095 doc: add an example for OVMF split images
Add an example to use "code=" and "vars=" in the dm parameters to launch
with OVMF split images.

Tracked-On: #5487
Signed-off-by: Peter Fang <peter.fang@intel.com>
Acked-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-11-11 09:53:28 +08:00
Yonghua Huang
5c3f6819d2 doc: update ivshmem feature HLD
With ivshmem doorbell feature enabled, HDL of it shall be updated.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-11-10 16:47:32 -08:00
David B. Kinder
a2167ae93a doc: add extension to create files and raw links
Links to files in the GitHub repo's master branch should be to the files
within the branch being generated.  For example, in the v2.1
documentation, links should be to the v2.1 branch contents.  (Previously
links were being made to the master branch in all our archived content.)
This creates a problem when we want to remove an obsolete file in the
master branch but can't because older documentaiton incorrectly depends
on it.

This new extension defines a :acrn_file: and :acrn_raw: role that will
create links to the given file within the current commit branch.

This PR also replaces docs with hard-coded links to files in the master
branch with uses of these new roles to create links to files.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-05 09:17:05 -08:00
David B. Kinder
6b45fc5517 doc: add sphinx-generated index to leftnav
Sphinx generates a full-site index (headings, terms, function names,
etc.) but we haven't been linking to it.  This is a tricky way to get
the site index added to the left nav that appears to work, by creating a
genindex.rst that we can link to in the site toctree so it shows up in
the leftnav, but the generated genindex.html for the dummy genindex.rst
will be overwritten by the sphinx created genindex.html with the
full-site index.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-05 09:16:45 -08:00
David B. Kinder
63fd853df3 doc: improve GSG navigation
Feedback suggests we add more top-level navigation to the getting
started guides, so let's include a local TOC as well as using the
"numbered-step" style to top-level steps.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-03 15:14:32 -08:00
fuzhongl
c94d628907 Doc: Update Debian as Service Vm
Update steps from de-privileged boot to direct boot.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-11-03 10:20:03 -08:00
David B. Kinder
9292e57786 doc: bring back prev/next buttons
Some ACRN docs (in particular the HLD) has content nested more than the
4 levels shown in the sidebar navigation.  So when looking at those
documents, it's hard to get to next chapter.  Bring back the
previous/next links to fix this situation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-03 09:07:41 -08:00
David B. Kinder
791b091bbe doc: more prep for upgrading doc build tools
Preparing for upgrading to newer versions of doc building tools
including sphing, doxygen, breathe, docutils, etc.  This PR's changes
still work find with the older tool versions, but should eliminate
issues found while moving to newer tool versions (later).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-01 10:12:17 -08:00
Shiqing Gao
76017ec67f doc: update coding guidelines
- add a rule for function parameter limit

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2020-10-30 08:36:21 -07:00
David B. Kinder
62d0088565 doc: doc spelling and grammer fixing
Continuing with additional spelling and grammar fixes missed during
retular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-30 08:32:53 -07:00
David B. Kinder
ec731bac0f doc: update doxygen configuration
Update some configuration settings that will be obsolete in the new
(1.8.17) doxygen release.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-26 09:20:50 -07:00