diff --git a/docs/docs/dev/debug/crash.md b/docs/docs/dev/debug/crash.md new file mode 100644 index 00000000..caeb404c --- /dev/null +++ b/docs/docs/dev/debug/crash.md @@ -0,0 +1,12 @@ +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 1d017e51..4c780e8a 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -106,6 +106,7 @@ 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: diff --git a/resources/xemu_dump_registry_config.zip b/resources/xemu_dump_registry_config.zip new file mode 100644 index 00000000..6fe08d92 Binary files /dev/null and b/resources/xemu_dump_registry_config.zip differ