Commit Graph

166 Commits

Author SHA1 Message Date
David B. Kinder
68ce114b43 doc: add tool for verifying installed doc tools
Added a python script that displays versions of doc building tools
(e.g., doxygen, breathe, sphinx) to help verify doc building environment
is properly set up (can help doc building problem diagnostic, as shown
in issue #1333

Update doc build documentation to reference this script.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-26 13:34:25 -07:00
ailin,yang
ac9ebc5e0f update to support v0.2 release
updated Clear Linux version to 25130 as getting started
updated pk kernel version to 4.14.68-99
added one bundle installation
2018-09-24 21:05:44 -07:00
David B. Kinder
d08256dfa9 doc: code-block text not readable
The .. code-block:: console directive (used for white text on a black
background) didn't handle some CSS cases properly resulting in
unreadable grey text on a black background.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 15:31:37 -07:00
David B. Kinder
23cf8079e7 doc: update tagged release doc build instructions
Update the doc build instructions to include how to update the version
navigation selector (bottom of the left nav panel), and make commands
for building and publishing specific tagged releases (e.g., 0.2)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 13:43:03 -07:00
David B. Kinder
b5bf00b6e0 doc: update doc version menu for v0.2 release
Update conf.py selector list to include version 0.2 documentation (and
fix an URL typo in the release notes).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 11:01:15 -07:00
David B. Kinder
c7d87795f0 doc: release notes update for v0.2 release
Remove "DRAFT" indicator, and a few tweaks to repo description and
download instructions noticed in PR #1316

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 10:44:19 -07:00
Xie, nanlin
8dba99f8c1 doc: Add new known issue in v0.2 release note.
Add new known issue in v0.2 release note.

Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2018-09-24 08:50:34 -07:00
David B. Kinder
f20ca31145 doc: add tags and checkout info to release notes
Add instructions for accessing source for the v0.2 tagged
release.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 23:19:26 -07:00
Xie, nanlin
6709a08580 doc: Add change log in v0.2 release note.
Add change log in v0.2 release note.

Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2018-09-20 21:30:57 -07:00
David B. Kinder
7dd3207a6a doc: fix typo in network virt hld
punctuation fix

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 10:23:48 -07:00
David B. Kinder
01ce3b6aee doc: sort title in developer HLD section
We've got enough docs now that it would be better to put them in sorted
order by title.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 10:11:12 -07:00
David B. Kinder
dae98a0409 doc: add network virtualization hld
Review, edit, and transcode network virtualization doc

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 10:02:43 -07:00
David B. Kinder
55a71e402d doc: add watchdog high-level design
Review, transcode, and publish watchdog high-level design doc.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 09:57:55 -07:00
David B. Kinder
31285a9fdd doc: add security hld document
review and publish ACRN security hld document, also added the oplus
replacement symbol

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 09:45:36 -07:00
David B. Kinder
40dfd3fc24 doc: edit 0.2 release notes
Followup #1281 update with some spelling and formatting fixes

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-18 09:19:48 -07:00
Xie, nanlin
737c29fad8 doc: Add known issues in v0.2 release note.
Add known issues and description in v0.2 release note.

Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2018-09-18 09:06:09 -07:00
David B. Kinder
a47f5d4129 doc: fix Makefile to address multiple publishers
Need to make sure the local projectacrn.github.io is in sync with the
master before starting up the publishing process.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-16 14:30:05 -07:00
David B. Kinder
41a171444b doc: fix spaces in release notes
Removed white space at the end of the line, and fixed a sentence that
did not have a space after the period.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-16 14:29:48 -07:00
Xie, nanlin
3c8157bf22 doc: Add new feature in v0.2 release note
Add new feature list and description in v0.2 release note.

Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2018-09-16 13:58:37 -07:00
David B. Kinder
42d9b24a54 doc: allow overriding displayed doc version
In special cases, we'd like to freeze doc versions based on a tag (e.g.,
tags/acrn-2018w34.4-140000p) and have that version show up on the
generated docs.  (Normally the version shown is from the
hypervisor/VERSION file.)

With this patch, if DOC_TAG=release then it uses a RELEASE=name
environment variable (e.g., from the make command line) to override the
displayed version:

    make DOC_TAG=release RELEASE=acrn-2018w34.4-140000p html
    make DOC_TAG=release RELEASE=acrn-2018w34.4-140000p publish

Assuming you've checked out the tagged branch (both for acrn-hypervisor
and acrn-kernel), these make commands will generate and publish docs to
https://projectacrn.github.io/acrn-2018w34.4-14000p

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-11 16:29:17 -07:00
Xie, nanlin
9e76cf4800 doc: Add fixed issues in v0.2 release note
Filter v0.2 fixed issues from github closed issue list.

Signed-off-by: Nanlin Xie <nanlin.xie@intel.com>
2018-09-10 20:58:35 -07:00
Minggui Cao
bfcf546180 Doc: add interrupt storm mitigation explanation.
Tracked-On: #866
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
Acked-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-09-11 09:01:06 +08:00
Geoffroy Van Cutsem
047f4e90a2 Documentation: update to AcrnGT official name
Update the ACRN documentation to use the official name of GVT-g
in ACRN to "AcrnGT" (ACRN-GT was previously widely used).

Also update the few occurences of "GVT-G" to "GVT-g" to be
consistent across our documentation. This includes a couple of
file name updates.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-09-06 21:51:23 -07:00
David B. Kinder
d32ef9b1eb doc: fix doc misspellings
fix misspellings in .rst files missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-05 16:06:19 -07:00
David B. Kinder
510300254c doc: prepare for versioned release notes
Break out each version release notes into a separate .rst file and an
organizing top-level release notes page.

Create a draft version for the v0.2 release notes.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-05 15:53:27 -07:00
Geoffroy Van Cutsem
ef1a730230 Documentation: correct URL pointing at sample 'acrn.conf' file
Update the Getting Started Guide to correct the URL pointing at
the sample 'acrn.conf' file that is in the source code tree.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-08-31 09:53:11 -07:00
David B. Kinder
348422dba6 doc: fix graphviz scanning and processing
The doc build process copies files using script/extract-content.py from
outside of the doc/ folder (specifically content in the tools/ folders).
The script was not copying graphviz directive files.  This has been
fixed and the embedded graphviz directives are not (properly) stored in
separate image/*.dot files.

Note the extract-content.py file is derived from the Zephyr project.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-08-30 14:05:50 -07:00
Fei Jiang
e49c42d698 Documentation: update GVT-G-porting-image1.png for AcrnGT official name
Signed-off-by: Fei Jiang <fei.jiang@intel.com>
2018-08-30 14:03:43 -07:00
Sainath Grandhi
38a1898542 hv: Fix comments referring to wrong hypervisor name
Fix comments referring to wrong hypervisor name

Signed-off-by: Sainath Grandhi <sainath.grandhi@intel.com>
2018-08-17 10:03:32 +08:00
ailin,yang
f4513f903d update to fix format issue of ReST
accept the feedback from David
align the content to meet the ReST
2018-08-16 09:02:15 -07:00
ailin,yang
5a6ee3f3b3 update doc -Using Ubuntu as the Service OS
1, update contents to align latest acrn and clear Linux release
2, change /etc/grub.d/40_custom file to specify 'insmod ext2', not 'insmod ext4' and github issue- https://github.com/projectacrn/acrn-hypervisor/issues/707
3, add tap device and network sharing enabling script as the example for ubuntu SOS
4, add several tips for new user to use ubuntu as the SOS

Signed-off-by: ailun258 ailin.yang@intel.com
2018-08-16 09:02:15 -07:00
ailin,yang
8ff0efc5da update user name cl_sos
verified again, with user name cl-sos. it doesn't work to fix #663 
but cl_sos is working, so update the user name to cl_sos.  that means 
clear has naming rules for user name
2018-08-16 08:22:23 -07:00
ailin,yang
cad8492a12 enable weston to fix: #663
add user and enable weston service to fix issue: #663
2018-08-15 05:08:29 -07:00
Conghui Chen
a2b299179d doc: update virtio-blk usage in HLD
Add parameters introduction for virtio-blk

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
Reviewed-by: Shuo Liu <shuo.a.liu@intel.com>
Reviewed-by: David B. Kinder <david.b.kinder@intel.com>
2018-08-10 10:33:21 +08:00
David B. Kinder
4753da4374 doc: add interrupt high-level design doc
Transcode, review, and publish interrupt high-level design document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-08-08 20:23:12 -07:00
David B. Kinder
9d9c97d668 doc: fix table in acrn-shell documentation
Fix an indentation problem during in doc review.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-08-03 09:05:16 -07:00
yonghuah
093f2f9980 Update acrn-shell.rst 2018-08-03 08:38:19 -07:00
yonghuah
9689227665 Update acrn-shell.rst 2018-08-03 08:38:19 -07:00
yonghuah
f9bf917a6a HV: Refine hypervisor shell commands
removed shell commands:
--vcpu_pause
--vcpu_resume
--lsreq
--(warm) reboot
--vcpu_dumpmem

updated shell commands:
--vm_console -> sos_console
--trigger crash -> reboot
--merge 'set_loglevel' & 'get_loglevel' to 'loglevel'

new adding shell commands:
--dumpmem --> dump host physical memory
2018-08-03 08:38:19 -07:00
David B. Kinder
56904bc235 doc: CSS tweak for table caption location
Default behavior is for figure captions below the figure, but table
captions above the table.  Tweak the CSS for tables to put the caption
below instead.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-08-01 11:18:49 -07:00
David B. Kinder
ce7257e12e doc: tweak logo href to projectacrn.org
Have the logo link to the project site rather than the doc site

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-31 12:04:36 -07:00
David B. Kinder
6d2553532a doc: fix doc errors from acrn_vhm_mm.h API changes
API changes to acrn-kernel/include/linux/vhm/acrn_vhm_mm.h in
https://github.com/projectacrn/acrn-kernel/pull/48 renamed functions
that were referenced in the GTG-g_api.rst document, causing the
documentation build to fail.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-31 09:47:46 -07:00
David B. Kinder
014bef6fec doc: add virtio-console HLD document
transcode, review, and publish virtio-console developer-guides doc

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-31 09:47:27 -07:00
David B. Kinder
d4d8a128cf doc: tweak formatting for :kbd: role
update custom css to make kbd tag more interesting

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-30 16:13:03 -07:00
David B. Kinder
9c3d77e4b9 doc: tweek known-issues pattern for hypercall API
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-30 10:34:42 -07:00
Liu, Xinwu
42c77e4cf4 Documentation: add needed library for acrnprobe
Two packages are needed in compiling environment with replacing commands
fdisk and debugfs.

On clear linux, they belong to os-core-dev.

Signed-off-by: Liu, Xinwu <xinwu.liu@intel.com>
Acked-by: Chen Gang <gang.c.chen@intel.com>
Acked-by: Yang Ailin <ailin.yang@intel.com>
2018-07-27 16:38:21 +08:00
David B. Kinder
53a5941b99 doc: add GVT-G porting guide
Transcode, review, and publish GVT-G porting guide documentation. Merged
glossary entries, added anchor links in GVT-g_api for referencing from
this document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 14:08:57 -07:00
David B. Kinder
746cbab979 doc: add UART virtualization documentation
transcode, review, and publish UART virtualization design and
documentation

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 14:01:35 -07:00
David B. Kinder
6c54cba985 doc: cleanup css, search, version choices
Update CSS customization to improve read-the-docs theme for our use.
Improved search results (removing most reST markup), improve display of
doc version choices.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 14:00:49 -07:00
David B. Kinder
3abfdbab72 doc: add script for syncing acrn-kernel for API gen
API doc generation includes kernel components provided by ACRN that live
in the acrn-kernel repo (not the acrn-hypervisor repo). We need to
include fetching the latest acrn-kernel sources when we do doc
generation, and update the documentation to mention we now need the
acrn-kernel repo as a sibling folder for the acrn-hypervisor repo
contents.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-24 17:20:43 -07:00