perf: switch CMAKE_BUILD_TYPE to Debug by default (#363)

Signed-off-by: msclock <[email protected]>
serious-scaffold · Sep 6, 2024 · 6c93e07 · 6c93e07
1 parent 292bab3
commit 6c93e07
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ A continuously evolving basic template for cpp development.
   - Supports `code coverage` with [lcov](https://github.com/linux-test-project/lcov), [gcovr](https://github.com/gcovr/gcovr), llvm-cov, and [opencppcoverage](https://github.com/OpenCppCoverage/OpenCppCoverage).
   - Supports `hardening compilation `for MSVC, Clang, and GCC.
   - Provides compile, header, application target generation.
-  - Build with preset build types: Debug, Release, RelWithDebInfo(Default), MinSizeRel.
+  - Build with preset build types: Debug(Default), Release, RelWithDebInfo, MinSizeRel.
   - Supports package managers: [vcpkg](https://github.com/microsoft/vcpkg), [conan](https://github.com/conan-io/cmake-conan), and [cpm](https://github.com/cpm-cmake/CPM.cmake).
 - Use [cmake-registry](https://github.com/msclock/cmake-registry) to provide various cmake modules and scripts.
 - Lint tool `pre-commit` integration with various linters, including [clang-format](https://github.com/pre-commit/mirrors-clang-format), [codespell](https://github.com/codespell-project/codespell), [markdownlint](https://github.com/igorshubovych/markdownlint-cli), and more.

diff --git a/cmake/presets/base.json b/cmake/presets/base.json
@@ -17,7 +17,7 @@
       "cacheVariables": {
         "CMAKE_EXPORT_COMPILE_COMMANDS": true,
         "CMAKE_COMPILE_WARNING_AS_ERROR": false,
-        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
+        "CMAKE_BUILD_TYPE": "Debug",
         "CMAKE_VERBOSE_MAKEFILE": "FALSE"
       }
     }

diff --git a/cmake/vcpkg/scripts/build_type.cmake b/cmake/vcpkg/scripts/build_type.cmake
@@ -6,12 +6,10 @@ This module initializes the build type.
 ]]
 
 if(NOT CMAKE_BUILD_TYPE)
-  message(
-    STATUS "Setting CMAKE_BUILD_TYPE to 'RelWithDebInfo' as none was specified."
-  )
+  message(STATUS "Setting CMAKE_BUILD_TYPE to 'Debug' as none was specified.")
 endif()
 set(CMAKE_BUILD_TYPE
-    RelWithDebInfo
+    Debug
     CACHE STRING "Choose the type of build.")
 
 # Set the possible values of build type for cmake-gui, ccmake

diff --git a/docs/tutorials/building.md b/docs/tutorials/building.md
@@ -61,7 +61,7 @@ The Table below shows the necessary variables for different platforms and config
  - `VCPKG_ROOT` and `VCPKG_INSTALLATION_ROOT` are same and both are optional and it's used to specify the path to a vcpkg installation directory. If not specified, cmake/vcpkg/vcpkg.toolchain.cmake will automatically create one for you.
  - `CMAKE_GENERATOR` is recommended to use Ninja as it's faster than the default generator.
  - `VCPKG_TARGET_TRIPLET/VCPKG_HOST_TRIPLET` is optional and it is automatically detected by cmake/vcpkg/vcpkg.toolchain.cmake if not specified.
- - `CMAKE_BUILD_TYPE` is optional and default is set to RelWithDebInfo by `cmake/vcpkg/vcpkg.toolchain.cmake`.
+ - `CMAKE_BUILD_TYPE` is optional and default is set to Debug by `cmake/vcpkg/vcpkg.toolchain.cmake`.
 ```
 
 Here's an example of building the project with the specified variables:

diff --git a/template/README.md.jinja b/template/README.md.jinja
@@ -45,7 +45,7 @@
   - Supports `code coverage` with [lcov](https://github.com/linux-test-project/lcov), [gcovr](https://github.com/gcovr/gcovr), llvm-cov, and [opencppcoverage](https://github.com/OpenCppCoverage/OpenCppCoverage).
   - Supports `hardening compilation `for MSVC, Clang, and GCC.
   - Provides compile, header, application target generation.
-  - Build with preset build types: Debug, Release, RelWithDebInfo(Default), MinSizeRel.
+  - Build with preset build types: Debug(Default), Release, RelWithDebInfo, MinSizeRel.
   - Supports package managers: [vcpkg](https://github.com/microsoft/vcpkg), [conan](https://github.com/conan-io/cmake-conan), and [cpm](https://github.com/cpm-cmake/CPM.cmake).
 - Use [cmake-registry](https://github.com/msclock/cmake-registry) to provide various cmake modules and scripts.
 - Lint tool `pre-commit` integration with various linters, including [clang-format](https://github.com/pre-commit/mirrors-clang-format), [codespell](https://github.com/codespell-project/codespell), [markdownlint](https://github.com/igorshubovych/markdownlint-cli), and more.

diff --git a/...]docs[% endif %]/[% if repo_name == 'ss-cpp' %]tutorials[% endif %]/building.md b/...]docs[% endif %]/[% if repo_name == 'ss-cpp' %]tutorials[% endif %]/building.md
@@ -61,7 +61,7 @@ The Table below shows the necessary variables for different platforms and config
  - `VCPKG_ROOT` and `VCPKG_INSTALLATION_ROOT` are same and both are optional and it's used to specify the path to a vcpkg installation directory. If not specified, cmake/vcpkg/vcpkg.toolchain.cmake will automatically create one for you.
  - `CMAKE_GENERATOR` is recommended to use Ninja as it's faster than the default generator.
  - `VCPKG_TARGET_TRIPLET/VCPKG_HOST_TRIPLET` is optional and it is automatically detected by cmake/vcpkg/vcpkg.toolchain.cmake if not specified.
- - `CMAKE_BUILD_TYPE` is optional and default is set to RelWithDebInfo by `cmake/vcpkg/vcpkg.toolchain.cmake`.
+ - `CMAKE_BUILD_TYPE` is optional and default is set to Debug by `cmake/vcpkg/vcpkg.toolchain.cmake`.
 ```
 
 Here's an example of building the project with the specified variables:

diff --git a/template/cmake/presets/base.json b/template/cmake/presets/base.json
@@ -17,7 +17,7 @@
       "cacheVariables": {
         "CMAKE_EXPORT_COMPILE_COMMANDS": true,
         "CMAKE_COMPILE_WARNING_AS_ERROR": false,
-        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
+        "CMAKE_BUILD_TYPE": "Debug",
         "CMAKE_VERBOSE_MAKEFILE": "FALSE"
       }
     }

diff --git a/template/cmake/vcpkg/scripts/build_type.cmake b/template/cmake/vcpkg/scripts/build_type.cmake
@@ -6,12 +6,10 @@ This module initializes the build type.
 ]]
 
 if(NOT CMAKE_BUILD_TYPE)
-  message(
-    STATUS "Setting CMAKE_BUILD_TYPE to 'RelWithDebInfo' as none was specified."
-  )
+  message(STATUS "Setting CMAKE_BUILD_TYPE to 'Debug' as none was specified.")
 endif()
 set(CMAKE_BUILD_TYPE
-    RelWithDebInfo
+    Debug
     CACHE STRING "Choose the type of build.")
 
 # Set the possible values of build type for cmake-gui, ccmake