From de4e2b36c01d28b95364ff465566eb749d7e2d29 Mon Sep 17 00:00:00 2001
From: Matt Borgerson <contact@mborgerson.com>
Date: Fri, 12 Jul 2024 10:49:32 -0700
Subject: [PATCH] Add crash debugging page

---
 docs/docs/dev/debug/crash.md            |  12 ++++++++++++
 docs/mkdocs.yml                         |   1 +
 resources/xemu_dump_registry_config.zip | Bin 0 -> 733 bytes
 3 files changed, 13 insertions(+)
 create mode 100644 docs/docs/dev/debug/crash.md
 create mode 100644 resources/xemu_dump_registry_config.zip

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 0000000000000000000000000000000000000000..6fe08d92bb2f26d113e43fe1eaa76432b13d4b44
GIT binary patch
literal 733
zcmWIWW@Zs#U|`^2=#}~sHf7<Wg2N0949tuS3|tHh3_-4rF21gMB^4#6{Rg?490c0l
zH@!EQo_CSCB>IfOB`$8IhzYLlvA1Mq#%{c4SAKBknZ&ex|7RCTvDub<IC?%ra@Ew8
zvtAnCl1*mcY{r)5_EaFI|H33gliy!cSFL?4zvtuj{>2teOE(q&TJ<Sg>C-9!&$3-h
zKGoUU&0FM?x-eVKd+lU@TN9JpTb)n&@Tm43$#Xn?$6IDk^Oqp&Ka2P+wjM0J7`V-y
zdsXR)gt=Vd(Gi6QD^s$TNjWywvrTFC{UEgcwxi7vH??^}PLE#jBfR>X_e)sZ8lfKs
zj0_B4m>3v90Z@^eTN<B}pPZNzpHiAzP^?#!nqE68-}_L2$g%qM&HI{vta3=XwM_7f
zQdrOuRyEHQj~!bYt!7SsbvpdK-pjk!x(>gyt)KV#PWtnE>(47HdNV2AiwItLp4<58
zHI*YZ8pR8<R%ispJdFDqaW&v$&_;Jz_ig9r{gm7JB+8b*=Vej%`I+AgZQt(83cs_$
z>XF}8KIXPl-+h;<pX=PAywTmK^ijv2T}gAYx_#aMEUroYb7Vo<p>k3GinMc<(qgNY
z>%4c;6S=;1`M=45ad#7~Ud?(v<%|F7IiIo$*i9^-xU6<R`=^*U{LQubX@3^?-2cIx
z|9M_y{qJ>a)Q+y)*R^KNW!=;>tG*O1k4nv5xUEk6^6hg8Q8MCJatx>4f0dn?CH64j
zSjP1~S89E07gu|qIm3LnplW)f+Pf!f0$)hKn7XdS`G2`-x&9aF0B=Sn5pZZ?PfiRB
v3=E763Lpw4aUtu&7B>(LAbqbH7#Og{RDd@t8%Pxs0~13P0|SFE6Nm=@mQpi%

literal 0
HcmV?d00001