Skip to content

Commit 9e33987

Browse files
committed
fixup: documentation
Signed-off-by: Doru Blânzeanu <[email protected]>
1 parent 2843618 commit 9e33987

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/how-to-debug-a-hyperlight-guest.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,15 +205,17 @@ involved in the gdb debugging of a Hyperlight guest running inside a **KVM** or
205205
206206
## Dumping the guest state to an ELF core dump when an unhandled crash occurs
207207
208-
When a guest crashes, the vCPU state is dumped to an `ELF` core dump file. This can be used to inspect the state of the guest at the time of the crash.
208+
When a guest crashes because of an unknown VmExit or unhandled exception, the vCPU state is dumped to an `ELF` core dump file.
209+
This can be used to inspect the state of the guest at the time of the crash.
209210
210-
To dump the state of the vCPU (general purpose registers, registers) to an `ELF` core dump file set the feature `crashdump` and run a debug build. This will result in a dump file being created in the temporary directory.
211+
To make Hyperlight dump the state of the vCPU (general purpose registers, registers) to an `ELF` core dump file, set the feature `crashdump` and run a debug build.
212+
This will result in a dump file being created in the temporary directory.
211213
The name and location of the dump file will be printed to the console and logged as an error message.
212214
213215
### Inspecting the core dump
214216
215217
After the core dump has been created, to inspect the state of the guest, load the core dump file using `gdb` or `lldb`.
216-
A `gdb` version later than `15.0` and `lldb` version later than `17` have been used to test this feature.
218+
**NOTE: This feature has been tested with version `15.0` of `gdb` and version `17` of `lldb`, earlier versions may not work, it is recommended to use these versions or later.**
217219
218220
To do this in vscode, the following configuration can be used to add debug configurations:
219221
@@ -269,7 +271,7 @@ To do this in vscode, the following configuration can be used to add debug confi
269271
]
270272
}
271273
```
272-
NOTE: The `CodeLldb` debug session does not stop after launching. To see the code, stack frames and registers you need to
274+
**NOTE: The `CodeLldb` debug session does not stop after launching. To see the code, stack frames and registers you need to
273275
press the `pause` button. This is a known issue with the `CodeLldb` extension [#1245](https://github.com/vadimcn/codelldb/issues/1245).
274-
The `cppdbg` extension works as expected and stops at the entry point of the program.
276+
The `cppdbg` extension works as expected and stops at the entry point of the program.**
275277

0 commit comments

Comments
 (0)