From 0c47f4d04df29c8f4a99f2570f66ff18832b6f7a Mon Sep 17 00:00:00 2001 From: Minggui Cao Date: Wed, 3 Aug 2022 15:51:18 +0800 Subject: [PATCH] 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 Signed-off-by: David B. Kinder --- doc/user-guides/acrn-shell.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/user-guides/acrn-shell.rst b/doc/user-guides/acrn-shell.rst index 6c8f808f7..8c2f59f3c 100644 --- a/doc/user-guides/acrn-shell.rst +++ b/doc/user-guides/acrn-shell.rst @@ -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