From c2d6918fea5112dfabbd2189b224399e3e0de6d3 Mon Sep 17 00:00:00 2001
From: William Vinnicombe <william.vinnicombe@raspberrypi.com>
Date: Fri, 23 Aug 2024 16:04:35 +0100
Subject: [PATCH] Add comment to updateSectionRegex about flags

---
 src/utils/cmakeUtil.mts | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/utils/cmakeUtil.mts b/src/utils/cmakeUtil.mts
index 023dd984..17c2ac92 100644
--- a/src/utils/cmakeUtil.mts
+++ b/src/utils/cmakeUtil.mts
@@ -307,6 +307,7 @@ export async function cmakeUpdateSDK(
 ): Promise<boolean> {
   // TODO: support for scaning for seperate locations of the CMakeLists.txt file in the project
   const cmakeFilePath = join(folder.fsPath, "CMakeLists.txt");
+  // This regex requires multiline (m) and dotall (s) flags to work
   const updateSectionRegex =
     new RegExp(`^# ${CMAKE_DO_NOT_EDIT_HEADER_PREFIX}.*# =+$`, "ms");
   const picoBoardRegex = /^set\(PICO_BOARD\s+([^)]+)\)$/m;