Commit Graph

13 Commits

Author SHA1 Message Date
David B. Kinder
97f1f86cc0 doc: tweak dm-parameter doc
Remove trailing blanks, and change one last reviewer comment.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-12 16:46:21 +08:00
Shuang Zheng
381c78a5fa Update and complete acrn-dm parameters description
Update and complete `acrn-dm` parameters description in the user guide and HLD

Tracked-On: #2036
Signed-off-by: Shuang Zheng shuang.zheng@intel.com
2019-01-12 16:46:09 +08:00
David B. Kinder
e50cd15304 doc: spell check and formatting
Fix misspellings missed during regular reviews, and remove trailing
white space and Windows \r at end of lines.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-12 16:44:00 +08:00
Peter Fang
f5a66e8e20 doc: update OVMF usage for acrn-dm
Tracked-On: #1832
Signed-off-by: Peter Fang <peter.fang@intel.com>
2018-12-13 09:56:09 +08:00
David B. Kinder
e4143ca138 doc: fix use of double dashes
Sphinx transforms ``--`` into an en-dash within a paragraph (not within
a code, pre, or kbd block though).  This presents a problem documenting
command parameters such as ``--name`` where the ``--`` is transformed
into a single en-dash.  Rather than disabling all smartquote
transformations in the Sphinx conf.py (setting ``smartquotes = False``),
we fixes cases where ``--`` should not be transformed by using a block
that is ignored by the smartquote transformation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-12 15:06:43 -08:00
David B. Kinder
6dec166779 doc: improve acrn-dm param layout
Use a table instead of a dictionary list to make the parameter
description layout more readable.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-12 11:02:05 -08:00
Geoffroy Van Cutsem
21a5b30865 Update add acrn-dm parameter descriptions
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
David B. Kinder
ac5b46eba5 doc: update rest of hypervisor HLD sections
Transcode, edit, and upload HLD 0.7 section 3.10 (PM in hypervisor),
3.11 (Console, shell, vUART), 3.12 (Hypercall/VHM upcall), and
3.13 (Compile-time config)

Also scan/replace UTF-8 punctuation missed in previous PRs.

Add anchor targets in referenced docs.

Tracked-on: #1648

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-30 11:20:09 -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
3965593df6 doc: reorganize documentation
We've been expanding documentation, and now need to organize things a bit
cleaner and separate content into new major folders: Introduction, Getting
Started, User Guides, Developer Guides, Tutorials, and Release notes..

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:36:13 -07:00