mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-09-07 20:00:13 +00:00
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>
This commit is contained in:
committed by
David Kinder
parent
5c75f29a2d
commit
3965593df6
55
doc/user-guides/acrn-shell.rst
Normal file
55
doc/user-guides/acrn-shell.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
.. acrnshell:
|
||||
|
||||
ACRN Shell Commands
|
||||
###################
|
||||
|
||||
The ACRN hypervisor shell supports the following commands:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:widths: 40 60
|
||||
|
||||
* - Command (and parameters)
|
||||
- Description
|
||||
* - help
|
||||
- Displays information about supported hypervisor shell commands
|
||||
* - vm_list
|
||||
- Lists all VMs, displaying VM Name, VM ID, and VM State (ON=running)
|
||||
* - vcpu_list
|
||||
- Lists all VCPUs in all VMs
|
||||
* - vcpu_pause <vm_id, vcpu_id>
|
||||
- Pauses a specific VCPU
|
||||
* - vcpu_resume <vm_id, vcpu_id>
|
||||
- Resumes a specific VCPU
|
||||
* - vcpu_dumpreg <vm_id, vcpu_id>
|
||||
- Dumps registers for a specific VCPU
|
||||
* - vcpu_dumpmem <vm_id, vcpu_id, GVA, length>
|
||||
- Dumps memory for a specific VCPU, starting a given address, and for
|
||||
a given length (in bytes)
|
||||
* - vm_console
|
||||
- Switches to the SOS's console
|
||||
* - int
|
||||
- Lists interrupt information per CPU
|
||||
* - pt
|
||||
- Shows pass-through device information
|
||||
* - reboot
|
||||
- Triggers a system warm reboot (immediately)
|
||||
* - lsreq
|
||||
- Shows ioreq information
|
||||
* - dump_ioapic
|
||||
- Shows native ioapic information
|
||||
* - vmexit
|
||||
- Shows vmexit profiling
|
||||
* - logdump <pcpu_id>
|
||||
- Dumps the log buffer for the physical CPU
|
||||
* - trace <cpumask, ms>
|
||||
- Dumps a CPU's recent events within <ms> milliseconds
|
||||
* - get_loglevel
|
||||
- Get the loglevel
|
||||
* - set_loglevel <console_loglevel> [mem_loglevel]
|
||||
- Set loglevel [0 (none) - 6 (verbose)] for the console and optionally
|
||||
for memory
|
||||
* - cpuid <leaf> [subleaf]
|
||||
- Displays the CPUID leaf [subleaf], in hexadecimal
|
||||
* - crash
|
||||
- Triggers a system crash
|
10
doc/user-guides/index.rst
Normal file
10
doc/user-guides/index.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
.. _userguides:
|
||||
|
||||
User Guides
|
||||
###########
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
acrn-shell.rst
|
||||
tools.rst
|
10
doc/user-guides/tools.rst
Normal file
10
doc/user-guides/tools.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
.. _tools:
|
||||
|
||||
Tools
|
||||
#####
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
../tools/**
|
Reference in New Issue
Block a user