From a0c76b4ef76e219483755ff61dce6b67ff79f24b Mon Sep 17 00:00:00 2001
From: Juan Ramos <juan@lunarg.com>
Date: Mon, 28 Aug 2023 11:01:39 -0600
Subject: [PATCH] cmake: Document vlk_get_header_version

---
 CMakeLists.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 5d9317f..ef7a803 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -7,6 +7,10 @@
 # ~~~
 cmake_minimum_required(VERSION 3.15...3.25)
 
+# NOTE: Parsing the version like this is suboptimal but neccessary due to our release process:
+# https://github.com/KhronosGroup/Vulkan-Headers/pull/346
+#
+# As shown a more robust approach would be just to add basic test code to check the project version.
 function(vlk_get_header_version)
     set(vulkan_core_header_file "${CMAKE_CURRENT_SOURCE_DIR}/include/vulkan/vulkan_core.h")
     if (NOT EXISTS ${vulkan_core_header_file})