From 0c60a2a6672b406e0adf7a46a63fd260f3d9fb13 Mon Sep 17 00:00:00 2001 From: fgh1999 Date: Thu, 18 Apr 2024 08:46:13 +0000 Subject: [PATCH] Update docs about the GDB server address --- .gitignore | 1 + docs/src/kernel/advanced-instructions.md | 4 ++++ docs/src/osdk/reference/commands/run.md | 2 +- 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index f6dd2427f..0ed877a55 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,4 @@ virtio-net.pcap # vscode launch config file .vscode/launch.json +.vscode/launch.bak diff --git a/docs/src/kernel/advanced-instructions.md b/docs/src/kernel/advanced-instructions.md index 949ccff99..4c0695c04 100644 --- a/docs/src/kernel/advanced-instructions.md +++ b/docs/src/kernel/advanced-instructions.md @@ -74,6 +74,10 @@ Start a GDB-enabled VM of Asterinas with OSDK and wait for debugging connection: make gdb_server ``` +The server will listen at the default address specified in `Makefile`, i.e., a local TCP port `:1234`. +Change the address in `Makefile` for your convenience, +and check `cargo osdk run -h` for more details about the address. + Two options are provided to interact with the debug server. - A GDB client: start a GDB client in another terminal. diff --git a/docs/src/osdk/reference/commands/run.md b/docs/src/osdk/reference/commands/run.md index e7296b9a1..049ac5984 100644 --- a/docs/src/osdk/reference/commands/run.md +++ b/docs/src/osdk/reference/commands/run.md @@ -23,7 +23,7 @@ Options related with debugging: Requires [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb). - `--gdb-server-addr `: The network address on which the GDB server listens, it can be either a path for the UNIX domain socket or a TCP port on an IP address. -[default: .aster-gdb-socket] +[default: `.aster-gdb-socket`(a local UNIX socket)] See [Debug Command](debug.md) to interact with the GDB server in terminal.