From 793eba68d1bb9c1a114fd49ef98c69b5eeeaed44 Mon Sep 17 00:00:00 2001
From: adam-bloom <adamb529@gmail.com>
Date: Sat, 25 Sep 2021 14:31:35 -0600
Subject: [PATCH] add additional comments on SDL resolution

---
 src/openrct2-ui/CMakeLists.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/openrct2-ui/CMakeLists.txt b/src/openrct2-ui/CMakeLists.txt
index 953652bb98..e1545cbd4b 100644
--- a/src/openrct2-ui/CMakeLists.txt
+++ b/src/openrct2-ui/CMakeLists.txt
@@ -37,6 +37,12 @@ if (APPLE)
     set_source_files_properties(${OPENRCT2_UI_MM_SOURCES} PROPERTIES COMPILE_FLAGS "-x objective-c++ -fmodules")
     if ("${CMAKE_OSX_ARCHITECTURES}" MATCHES "arm64")
         # cross-compilation workaround for SDL2
+        # This has been addressed upstream in https://github.com/libsdl-org/SDL/commit/bf1d7a3a15a6c090188974bec8ca84eb1903d4f7
+        # Remove this workaround after:
+        # 1) a new SDL release is made containing that fix
+        # 2) The vcpkg port is updated to use that release
+        # 3) A new Dependencies release is made with that latest vcpkg version
+        # 4) That new release is used in this build
         set(SDL_DISABLE_IMMINTRIN_H "-DSDL_DISABLE_IMMINTRIN_H")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${SDL_DISABLE_IMMINTRIN_H}")
     endif ()