From 2c2dec50f9eead6bb20673bf99d0afacaeb3dee8 Mon Sep 17 00:00:00 2001 From: Yi Wang Date: Wed, 7 Jan 2026 00:09:36 +0800 Subject: [PATCH] docs: fix minor syntax issues for debug There are some minor syntax and command issues in debug-port document. As commit 5febdec81a69 (vmm: Enable `gdbstub` on AArch64) supported aarch64, the docs should keep consistent. Signed-off-by: Yi Wang --- docs/debug-port.md | 6 +++--- docs/gdb.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/debug-port.md b/docs/debug-port.md index 8983a8f0c..490fae092 100644 --- a/docs/debug-port.md +++ b/docs/debug-port.md @@ -13,7 +13,7 @@ be used simultaneously. ### `0x80` I/O port -Whenever the guest write one byte between `0x0` and `0xF` on this particular +Whenever the guest writes one byte between `0x0` and `0xF` on this particular I/O port, `cloud-hypervisor` will log and timestamp that event at the `debug` log level. @@ -52,7 +52,7 @@ to easily grep for the tracing logs (e.g. ``` ./target/debug/cloud-hypervisor \ - --kernel ~/rust-hypervisor-firmware/target/target/release/hypervisor-fw \ + --kernel ~/rust-hypervisor-firmware/target/release/hypervisor-fw \ --disk path=~/hypervisor/images/focal-server-cloudimg-amd64.raw \ --cpus 4 \ --memory size=1024M \ @@ -94,4 +94,4 @@ The `0x80` debug port and the port of the firmware debug device are always available. The debug console must be activated via the command line, but provides more configuration options. -You can use different ports for different aspect of your logging messages. +You can use different ports for different aspects of your logging messages. diff --git a/docs/gdb.md b/docs/gdb.md index 10b75c9f6..49449b019 100644 --- a/docs/gdb.md +++ b/docs/gdb.md @@ -1,6 +1,6 @@ # GDB Support -This feature allows remote guest debugging using GDB. Note that this feature is only supported on x86_64/KVM. +This feature allows remote guest debugging using GDB. Note that this feature is supported on x86_64 and aarch64 with KVM. To enable debugging with GDB, build with the `guest_debug` feature enabled: