add documentation for /Zi flag

bemanproject · Jan 9, 2025 · ae2f060 · ae2f060
1 parent 58b5b05
commit ae2f060
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/cmake/msvc-toolchain.cmake b/cmake/msvc-toolchain.cmake
@@ -19,6 +19,8 @@ set(CMAKE_C_COMPILER cl)
 set(CMAKE_CXX_COMPILER cl)
 
 if(BEMAN_BUILDSYS_SANITIZER STREQUAL "MaxSan")
+    # /Zi flag (add debug symbol) is needed when using address sanitizer
+    # See C5072: https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-c5072
     set(SANITIZER_FLAGS "/fsanitize=address /Zi")
 endif()