From d50771ca12346c58717bd5047836a620de45fcad Mon Sep 17 00:00:00 2001 From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com> Date: Wed, 25 Dec 2024 20:13:14 -0600 Subject: [PATCH 1/2] Update Windows compile instructions to not imply that debug is on by default. Implying Debug is selected by default may cause someone to think they messed up if they reach this step and it's not on Debug. Happened to me. This change just cleans up the wording. --- docs/dev/compile/Compile.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev/compile/Compile.rst b/docs/dev/compile/Compile.rst index 19fbce2c1e..809254e8be 100644 --- a/docs/dev/compile/Compile.rst +++ b/docs/dev/compile/Compile.rst @@ -162,8 +162,8 @@ or VC2022_32, depending on the architecture you specified. Open the file ``dfhack.sln`` inside that folder. If you have multiple versions of Visual Studio installed, make sure you open with Visual Studio 2022. -The first thing you must then do is change the build type. It defaults to Debug, -but this cannot be used on Windows. Debug is not binary-compatible with DF. +The first thing you must then do is ensure the build type is not Debug, which +cannot be used on Windows. Debug is not binary-compatible with DF. If you try to use a debug build with DF, you'll only get crashes and for this reason the Windows "debug" scripts actually do RelWithDebInfo builds. After loading the Solution, change the Build Type to either ``Release`` From c81716dfe472a817338ecb513fdc43eceb68a775 Mon Sep 17 00:00:00 2001 From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com> Date: Thu, 26 Dec 2024 17:20:01 -0600 Subject: [PATCH 2/2] Fixed trailing whitespace --- docs/dev/compile/Compile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev/compile/Compile.rst b/docs/dev/compile/Compile.rst index 809254e8be..3eea95d880 100644 --- a/docs/dev/compile/Compile.rst +++ b/docs/dev/compile/Compile.rst @@ -162,7 +162,7 @@ or VC2022_32, depending on the architecture you specified. Open the file ``dfhack.sln`` inside that folder. If you have multiple versions of Visual Studio installed, make sure you open with Visual Studio 2022. -The first thing you must then do is ensure the build type is not Debug, which +The first thing you must then do is ensure the build type is not Debug, which cannot be used on Windows. Debug is not binary-compatible with DF. If you try to use a debug build with DF, you'll only get crashes and for this reason the Windows "debug" scripts actually do RelWithDebInfo builds.