Skip to content

Commit a1213ef

Browse files
committed
fixup: documentation
Signed-off-by: Doru Blânzeanu <[email protected]>
1 parent 616ef3d commit a1213ef

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
@@ -204,15 +204,17 @@ involved in the gdb debugging of a Hyperlight guest running inside a **KVM** or
204204
205205
## Dumping the guest state to an ELF core dump when an unhandled crash occurs
206206
207-
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.
207+
When a guest crashes because of an unknown VmExit or unhandled exception, the vCPU state is dumped to an `ELF` core dump file.
208+
This can be used to inspect the state of the guest at the time of the crash.
208209
209-
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.
210+
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.
211+
This will result in a dump file being created in the temporary directory.
210212
The name and location of the dump file will be printed to the console and logged as an error message.
211213
212214
### Inspecting the core dump
213215
214216
After the core dump has been created, to inspect the state of the guest, load the core dump file using `gdb` or `lldb`.
215-
A `gdb` version later than `15.0` and `lldb` version later than `17` have been used to test this feature.
217+
**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.**
216218
217219
To do this in vscode, the following configuration can be used to add debug configurations:
218220
@@ -268,7 +270,7 @@ To do this in vscode, the following configuration can be used to add debug confi
268270
]
269271
}
270272
```
271-
NOTE: The `CodeLldb` debug session does not stop after launching. To see the code, stack frames and registers you need to
273+
**NOTE: The `CodeLldb` debug session does not stop after launching. To see the code, stack frames and registers you need to
272274
press the `pause` button. This is a known issue with the `CodeLldb` extension [#1245](https://github.com/vadimcn/codelldb/issues/1245).
273-
The `cppdbg` extension works as expected and stops at the entry point of the program.
275+
The `cppdbg` extension works as expected and stops at the entry point of the program.**
274276

0 commit comments

Comments
 (0)