From 471b34f12557bb57a7e7a8088b7bd35f74fa093c Mon Sep 17 00:00:00 2001 From: Matt Borgerson Date: Tue, 16 Jul 2024 13:40:18 -0700 Subject: [PATCH] Move crash debugging section into host debugging page --- docs/docs/dev/debug/crash.md | 12 ------------ docs/docs/dev/debug/host.md | 16 +++++++++++++++- docs/mkdocs.yml | 1 - 3 files changed, 15 insertions(+), 14 deletions(-) delete mode 100644 docs/docs/dev/debug/crash.md diff --git a/docs/docs/dev/debug/crash.md b/docs/docs/dev/debug/crash.md deleted file mode 100644 index caeb404c..00000000 --- a/docs/docs/dev/debug/crash.md +++ /dev/null @@ -1,12 +0,0 @@ -Windows -------- - -### Getting a core dump - -If xemu is crashing and the reason is not clear, you can create a core dump to provide developers with to investigate. To create a core dump on Windows for crash analysis: - -First, apply the registry edit script found in this Zip file: [xemu_dump_registry_config.zip](https://xemu.app/xemu_dump_registry_config.zip). This registry edit will configure Windows to create a dump whenever xemu crashes. - -Then, download and run the debug build of xemu found at: https://github.com/xemu-project/xemu/releases/latest/download/xemu-win-debug.zip - -The dump will be stored at `%LOCALAPPDATA%\CrashDumps`. You may notice a delay after xemu crashes while this file is saved. diff --git a/docs/docs/dev/debug/host.md b/docs/docs/dev/debug/host.md index bf924a2e..e9fd3148 100644 --- a/docs/docs/dev/debug/host.md +++ b/docs/docs/dev/debug/host.md @@ -97,4 +97,18 @@ Follow the [build](../building-from-source.md) instructions appending `--debug` // start in a paused state "-S" ] - ``` \ No newline at end of file + ``` + +## Debugging crashes + +### Windows + +#### Getting a core dump + +If xemu is crashing and the reason is not clear, you can create a core dump to provide developers with to investigate. To create a core dump on Windows for crash analysis: + +First, apply the registry edit script found in this Zip file: [xemu_dump_registry_config.zip](https://xemu.app/xemu_dump_registry_config.zip). This registry edit will configure Windows to create a dump whenever xemu crashes. + +Then, download and run the debug build of xemu found at: https://github.com/xemu-project/xemu/releases/latest/download/xemu-win-debug.zip + +The dump will be stored at `%LOCALAPPDATA%\CrashDumps`. You may notice a delay after xemu crashes while this file is saved. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 4c780e8a..1d017e51 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -106,7 +106,6 @@ nav: - Host Debugging: dev/debug/host.md - Guest Debugging: dev/debug/guest.md - Graphics Debugging: dev/debug/graphics.md - - Crash Debugging: dev/debug/crash.md - Testing: testing.md plugins: