CMake: Improve preset display names and descriptions

Now all configure and build presets have consistently formatted
display names with useful content
This commit is contained in:
ayeteadoe 2025-06-25 09:25:12 -07:00 committed by Andrew Kaster
commit 75d26b1610
Notes: github-actions[bot] 2025-07-09 23:53:20 +00:00

View file

@ -68,12 +68,14 @@
{ {
"name": "Release", "name": "Release",
"inherits": "unix_base", "inherits": "unix_base",
"displayName": "Release Config" "displayName": "Release Config",
"description": "Release Unix build"
}, },
{ {
"name": "Debug", "name": "Debug",
"inherits": "unix_base", "inherits": "unix_base",
"displayName": "Debug Config", "displayName": "Debug Config",
"description": "Debug Unix build",
"binaryDir": "${fileDir}/Build/debug", "binaryDir": "${fileDir}/Build/debug",
"cacheVariables": { "cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug", "CMAKE_BUILD_TYPE": "Debug",
@ -84,7 +86,7 @@
"name": "Windows_Experimental", "name": "Windows_Experimental",
"inherits": "windows_base", "inherits": "windows_base",
"displayName": "Windows Experimental Config", "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", "binaryDir": "${fileDir}/Build/debug",
"cacheVariables": { "cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug", "CMAKE_BUILD_TYPE": "Debug",
@ -111,7 +113,7 @@
"Release" "Release"
], ],
"displayName": "Sanitizer Config", "displayName": "Sanitizer Config",
"description": "Sanitizer build", "description": "Sanitizer Unix build",
"binaryDir": "${fileDir}/Build/sanitizers", "binaryDir": "${fileDir}/Build/sanitizers",
"cacheVariables": { "cacheVariables": {
"ENABLE_UNDEFINED_SANITIZER": "ON", "ENABLE_UNDEFINED_SANITIZER": "ON",
@ -124,7 +126,8 @@
"inherits": [ "inherits": [
"Windows_Experimental" "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", "binaryDir": "${fileDir}/Build/sanitizers",
"cacheVariables": { "cacheVariables": {
"ENABLE_WINDOWS_CI": "OFF", "ENABLE_WINDOWS_CI": "OFF",
@ -140,6 +143,7 @@
"windows_base" "windows_base"
], ],
"displayName": "Windows CI Config", "displayName": "Windows CI Config",
"description": "CI Windows build",
"cacheVariables": { "cacheVariables": {
"ENABLE_WINDOWS_CI": "ON", "ENABLE_WINDOWS_CI": "ON",
"ENABLE_QT": "OFF" "ENABLE_QT": "OFF"
@ -151,6 +155,7 @@
"Windows_CI" "Windows_CI"
], ],
"displayName": "Windows Sanitizer CI Config", "displayName": "Windows Sanitizer CI Config",
"description": "Sanitizer CI Windows build",
"binaryDir": "${fileDir}/Build/sanitizers", "binaryDir": "${fileDir}/Build/sanitizers",
"cacheVariables": { "cacheVariables": {
"ENABLE_WINDOWS_CI": "ON", "ENABLE_WINDOWS_CI": "ON",
@ -164,7 +169,7 @@
"name": "Fuzzers", "name": "Fuzzers",
"inherits": "unix_base", "inherits": "unix_base",
"displayName": "Fuzzers Config", "displayName": "Fuzzers Config",
"description": "Fuzzers build", "description": "Fuzzers Unix build",
"binaryDir": "${fileDir}/Build/fuzzers", "binaryDir": "${fileDir}/Build/fuzzers",
"cacheVariables": { "cacheVariables": {
"BUILD_SHARED_LIBS": "OFF", "BUILD_SHARED_LIBS": "OFF",
@ -178,7 +183,7 @@
"name": "Swift_Release", "name": "Swift_Release",
"inherits": "unix_base", "inherits": "unix_base",
"displayName": "Swift Release Config", "displayName": "Swift Release Config",
"description": "Swift release build using Ninja generator", "description": "Swift-enabled Unix release build",
"binaryDir": "${fileDir}/Build/swift", "binaryDir": "${fileDir}/Build/swift",
"cacheVariables": { "cacheVariables": {
"ENABLE_SWIFT": "ON", "ENABLE_SWIFT": "ON",
@ -226,64 +231,64 @@
"name": "Release", "name": "Release",
"inherits": "unix_base", "inherits": "unix_base",
"configurePreset": "Release", "configurePreset": "Release",
"displayName": "Build", "displayName": "Release Build",
"description": "Build the project in release" "description": "Build the project in release on Unix"
}, },
{ {
"name": "Debug", "name": "Debug",
"inherits": "unix_base", "inherits": "unix_base",
"configurePreset": "Debug", "configurePreset": "Debug",
"displayName": "Build", "displayName": "Debug Build",
"description": "Build the project in debug" "description": "Build the project in debug on Unix"
}, },
{ {
"name": "Windows_Experimental", "name": "Windows_Experimental",
"inherits": "windows_base", "inherits": "windows_base",
"configurePreset": "Windows_Experimental", "configurePreset": "Windows_Experimental",
"displayName": "Build", "displayName": "Windows Experimental Build",
"description": "Build the project" "description": "Build the project in debug on Windows. Not all targets in this preset are supported"
}, },
{ {
"name": "Distribution", "name": "Distribution",
"inherits": "unix_base", "inherits": "unix_base",
"configurePreset": "Distribution", "configurePreset": "Distribution",
"displayName": "Build", "displayName": "Distribution Build",
"description": "Build the project for distribution" "description": "Build the project for distribution on Unix"
}, },
{ {
"name": "Sanitizer", "name": "Sanitizer",
"inherits": "unix_base", "inherits": "unix_base",
"configurePreset": "Sanitizer", "configurePreset": "Sanitizer",
"displayName": "Build with Sanitizers", "displayName": "Sanitizer Build",
"description": "Build the project with Sanitizers" "description": "Build the project with Sanitizers on Unix"
}, },
{ {
"name": "Windows_Sanitizer_Experimental", "name": "Windows_Sanitizer_Experimental",
"inherits": "windows_base", "inherits": "windows_base",
"configurePreset": "Windows_Sanitizer_Experimental", "configurePreset": "Windows_Sanitizer_Experimental",
"displayName": "Build with Sanitizers", "displayName": "Windows Sanitizer Experimental Build",
"description": "Build the project with Sanitizers" "description": "Build the project with Sanitizers on Windows. Not all targets in this preset are supported"
}, },
{ {
"name": "Windows_CI", "name": "Windows_CI",
"inherits": "windows_base", "inherits": "windows_base",
"configurePreset": "Windows_CI", "configurePreset": "Windows_CI",
"displayName": "Windows_CI Build", "displayName": "Windows CI Build",
"description": "Build the project for Windows CI" "description": "Build the project for Windows CI"
}, },
{ {
"name": "Windows_Sanitizer_CI", "name": "Windows_Sanitizer_CI",
"inherits": "windows_base", "inherits": "windows_base",
"configurePreset": "Windows_Sanitizer_CI", "configurePreset": "Windows_Sanitizer_CI",
"displayName": "Windows_Sanitizer_CI Build", "displayName": "Windows Sanitizer CI Build",
"description": "Build the project with sanitizers for Windows CI" "description": "Build the project with sanitizers for Windows CI"
}, },
{ {
"name": "Swift_Release", "name": "Swift_Release",
"inherits": "unix_base", "inherits": "unix_base",
"configurePreset": "Swift_Release", "configurePreset": "Swift_Release",
"displayName": "Build Swift Release", "displayName": "Swift Release Build",
"description": "Build the project for Swift release" "description": "Build the project for Swift release on Unix"
} }
], ],
"testPresets": [ "testPresets": [