OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: update hypervisor shell usage 

ACRN hypervisor shell has been improved to be bash-like shell, so update
its usage

Tracked-On: #7931
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
Minggui Cao 2022-08-03 15:51:18 +08:00 committed by David Kinder
parent 364295e0d8
commit 0c47f4d04d
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/user-guides/acrn-shell.rst
View File

@ -3,7 +3,17 @@
ACRN Shell Commands
###################
The ACRN hypervisor shell supports the following commands:
The ACRN shell is a text-based terminal for the hypervisor, accessible via the target system's serial port.
It is only available when the hypervisor build type is debug, the serial console port is configured, and a
terminal emulator on your development computer is connected, typically via a serial-to-USB cable.
The ACRN shell provides useful debugging commands for displaying internal system states, environment settings,
and hypervisor statistics as well as reading and writing CPU model-specific registers (MSR).
A short command history is maintained that lets you use the :kbd:`UP` and :kbd:`DOWN` keys to browse the command
history and :kbd:`HOME`, :kbd:`END`, :kbd:`LEFT`, and :kbd:`RIGHT` keys to select an edit point within the command.
Here's the list of commands supported by the ACRN shell, followed by example uses of these commands:
.. list-table::
:header-rows: 1