Merge pull request #1467 from contour-terminal/fix/cmake_release_presets

Update presets to handle build type and directories for release correctly
contour-terminal · Feb 13, 2024 · 826b623 · 826b623
2 parents 926e31f + cb9f616
commit 826b623
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -102,12 +102,14 @@ can be insalled via the system package manager.
 
 #### Compile
 
+You can use cmake presets to compile contour. The full list of available presets can be seen using `cmake --list-presets`. To compile release build for linux or MacOs use `linux-release` or `macos-release` accordingly. FreeBSD users can use `linux-release` or configure cmake manually.
+
 ```sh
-cmake -S . -B build -G Ninja
-cmake --build build/
+cmake --preset linux-release
+cmake --build --preset linux-release
 
 # Optionally, if you want to install from source
-cmake --build build/ --target install
+cmake --build --preset linux-release --target install
 ```
 
 #### Windows 10 or newer

diff --git a/cmake/presets/common.json b/cmake/presets/common.json
@@ -7,7 +7,6 @@
             "description": "Common settings for all configurations",
             "binaryDir": "${sourceDir}/build/${presetName}",
             "cacheVariables": {
-                "CMAKE_INSTALL_PREFIX": "${sourceDir}/out/install/${presetName}",
                 "CONTOUR_INSTALL_TOOLS": "ON",
                 "CONTOUR_TESTING": "ON",
                 "LIBTERMINAL_BUILD_BENCH_HEADLESS": "ON",
@@ -27,7 +26,8 @@
             "name": "debug",
             "hidden": true,
             "cacheVariables": {
-                "CMAKE_BUILD_TYPE": "Debug"
+                "CMAKE_BUILD_TYPE": "Debug",
+                "CMAKE_INSTALL_PREFIX": "${sourceDir}/out/install/${presetName}"
             }
         }
     ]

diff --git a/cmake/presets/os-linux.json b/cmake/presets/os-linux.json
@@ -11,9 +11,14 @@
                 "type": "equals",
                 "lhs": "${hostSystemName}",
                 "rhs": "Linux"
-            },
+            }
+        },
+        {
+            "name": "linux-common-release",
+            "hidden": true,
+            "inherits": "release",
             "cacheVariables": {
-                "CMAKE_BUILD_TYPE": "Debug"
+                "CMAKE_INSTALL_PREFIX": "/usr/local"
             }
         },
         {
@@ -35,7 +40,7 @@
         {
             "name": "linux-release",
             "displayName": "Linux 64-bit",
-            "inherits": ["linux-common", "release"]
+            "inherits": ["linux-common", "linux-common-release"]
         },
         {
             "name": "linux-debug",
@@ -45,7 +50,7 @@
         {
             "name": "linux-clang-release",
             "displayName": "Linux 64-bit (Clang)",
-            "inherits": ["linux-clang", "release"]
+            "inherits": ["linux-clang", "linux-common-release"]
         },
         {
             "name": "linux-clang-debug",
@@ -55,7 +60,7 @@
         {
             "name": "linux-gcc-release",
             "displayName": "Linux 64-bit (GCC)",
-            "inherits": ["linux-gcc", "release"]
+            "inherits": ["linux-gcc", "linux-common-release"]
         },
         {
             "name": "linux-gcc-debug",

diff --git a/docs/install.md b/docs/install.md
@@ -65,12 +65,14 @@ can be insalled via the system package manager.
 
 #### Compile
 
+You can use cmake presets to compile contour. The full list of available presets can be seen using `cmake --list-presets`. To compile release build for linux or MacOs use `linux-release` or `macos-release` accordingly. FreeBSD users can use `linux-release` or configure cmake manually.
+
 ```sh
-cmake -S . -B build -G Ninja
-cmake --build build/
+cmake --preset linux-release 
+cmake --build --preset linux-release
 
 # Optionally, if you want to install from source
-cmake --build build/ --target install
+cmake --build --preset linux-release --target install
 ```
 
 Please mind, if you want to install into a system root, e.g. `/usr/local`, you may need to prefix