From 75d26b161008feed7bd7d9827ef916bc89c231db Mon Sep 17 00:00:00 2001
From: ayeteadoe <ayeteadoe@gmail.com>
Date: Wed, 25 Jun 2025 09:25:12 -0700
Subject: [PATCH] CMake: Improve preset display names and descriptions

Now all configure and build presets have consistently formatted
display names with useful content
---
 CMakePresets.json | 49 ++++++++++++++++++++++++++---------------------
 1 file changed, 27 insertions(+), 22 deletions(-)

diff --git a/CMakePresets.json b/CMakePresets.json
index 0ecbce80abe..f6687412e3f 100644
--- a/CMakePresets.json
+++ b/CMakePresets.json
@@ -68,12 +68,14 @@
     {
       "name": "Release",
       "inherits": "unix_base",
-      "displayName": "Release Config"
+      "displayName": "Release Config",
+      "description": "Release Unix build"
     },
     {
       "name": "Debug",
       "inherits": "unix_base",
       "displayName": "Debug Config",
+      "description": "Debug Unix build",
       "binaryDir": "${fileDir}/Build/debug",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Debug",
@@ -84,7 +86,7 @@
       "name": "Windows_Experimental",
       "inherits": "windows_base",
       "displayName": "Windows Experimental Config",
-      "description": "Experimental windows configuration that builds all targets, allowing for gradual increase in support",
+      "description": "Experimental Windows build. Not all targets in this preset are supported",
       "binaryDir": "${fileDir}/Build/debug",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Debug",
@@ -111,7 +113,7 @@
         "Release"
       ],
       "displayName": "Sanitizer Config",
-      "description": "Sanitizer build",
+      "description": "Sanitizer Unix build",
       "binaryDir": "${fileDir}/Build/sanitizers",
       "cacheVariables": {
         "ENABLE_UNDEFINED_SANITIZER": "ON",
@@ -124,7 +126,8 @@
       "inherits": [
         "Windows_Experimental"
       ],
-      "displayName": "Windows Sanitizer Config",
+      "displayName": "Windows Sanitizer Experimental Config",
+      "description": "Experimental sanitizer Windows build. Not all targets in this preset are supported",
       "binaryDir": "${fileDir}/Build/sanitizers",
       "cacheVariables": {
         "ENABLE_WINDOWS_CI": "OFF",
@@ -140,6 +143,7 @@
         "windows_base"
       ],
       "displayName": "Windows CI Config",
+      "description": "CI Windows build",
       "cacheVariables": {
         "ENABLE_WINDOWS_CI": "ON",
         "ENABLE_QT": "OFF"
@@ -151,6 +155,7 @@
         "Windows_CI"
       ],
       "displayName": "Windows Sanitizer CI Config",
+      "description": "Sanitizer CI Windows build",
       "binaryDir": "${fileDir}/Build/sanitizers",
       "cacheVariables": {
         "ENABLE_WINDOWS_CI": "ON",
@@ -164,7 +169,7 @@
       "name": "Fuzzers",
       "inherits": "unix_base",
       "displayName": "Fuzzers Config",
-      "description": "Fuzzers build",
+      "description": "Fuzzers Unix build",
       "binaryDir": "${fileDir}/Build/fuzzers",
       "cacheVariables": {
         "BUILD_SHARED_LIBS": "OFF",
@@ -178,7 +183,7 @@
       "name": "Swift_Release",
       "inherits": "unix_base",
       "displayName": "Swift Release Config",
-      "description": "Swift release build using Ninja generator",
+      "description": "Swift-enabled Unix release build",
       "binaryDir": "${fileDir}/Build/swift",
       "cacheVariables": {
         "ENABLE_SWIFT": "ON",
@@ -226,64 +231,64 @@
       "name": "Release",
       "inherits": "unix_base",
       "configurePreset": "Release",
-      "displayName": "Build",
-      "description": "Build the project in release"
+      "displayName": "Release Build",
+      "description": "Build the project in release on Unix"
     },
     {
       "name": "Debug",
       "inherits": "unix_base",
       "configurePreset": "Debug",
-      "displayName": "Build",
-      "description": "Build the project in debug"
+      "displayName": "Debug Build",
+      "description": "Build the project in debug on Unix"
     },
     {
       "name": "Windows_Experimental",
       "inherits": "windows_base",
       "configurePreset": "Windows_Experimental",
-      "displayName": "Build",
-      "description": "Build the project"
+      "displayName": "Windows Experimental Build",
+      "description": "Build the project in debug on Windows. Not all targets in this preset are supported"
     },
     {
       "name": "Distribution",
       "inherits": "unix_base",
       "configurePreset": "Distribution",
-      "displayName": "Build",
-      "description": "Build the project for distribution"
+      "displayName": "Distribution Build",
+      "description": "Build the project for distribution on Unix"
     },
     {
       "name": "Sanitizer",
       "inherits": "unix_base",
       "configurePreset": "Sanitizer",
-      "displayName": "Build with Sanitizers",
-      "description": "Build the project with Sanitizers"
+      "displayName": "Sanitizer Build",
+      "description": "Build the project with Sanitizers on Unix"
     },
     {
       "name": "Windows_Sanitizer_Experimental",
       "inherits": "windows_base",
       "configurePreset": "Windows_Sanitizer_Experimental",
-      "displayName": "Build with Sanitizers",
-      "description": "Build the project with Sanitizers"
+      "displayName": "Windows Sanitizer Experimental Build",
+      "description": "Build the project with Sanitizers on Windows. Not all targets in this preset are supported"
     },
     {
       "name": "Windows_CI",
       "inherits": "windows_base",
       "configurePreset": "Windows_CI",
-      "displayName": "Windows_CI Build",
+      "displayName": "Windows CI Build",
       "description": "Build the project for Windows CI"
     },
     {
       "name": "Windows_Sanitizer_CI",
       "inherits": "windows_base",
       "configurePreset": "Windows_Sanitizer_CI",
-      "displayName": "Windows_Sanitizer_CI Build",
+      "displayName": "Windows Sanitizer CI Build",
       "description": "Build the project with sanitizers for Windows CI"
     },
     {
       "name": "Swift_Release",
       "inherits": "unix_base",
       "configurePreset": "Swift_Release",
-      "displayName": "Build Swift Release",
-      "description": "Build the project for Swift release"
+      "displayName": "Swift Release Build",
+      "description": "Build the project for Swift release on Unix"
     }
   ],
   "testPresets": [