Add cmakeBuildType and dontAddCmakeBuildType variables to be able to make Debug builds.

[nbp]

Motivation for this change

Current cmake setup-tools.sh only allow us to make release builds, and one cannot just remove the command as it is baked in right before calling cmake.

This pull request add the ability to set cmakeBuildType attribute, and default to Release.
This change is likely a mass-rebuild, so I am making this pull request against the staging branch.

Things done

• Tested using sandboxing
  (nix.useChroot on NixOS,
  or option build-use-chroot in nix.conf
  on non-NixOS)
• Built on platform(s)
  • NixOS
  • OS X
  • Linux
• Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
• Tested execution with rr.
• Tested execution of all binary files (usually in ./result/bin/)
• Fits CONTRIBUTING.md.

[mention-bot]

@nbp, thanks for your PR! By analyzing the annotation information on this pull request, we identified @ttuegel, @edolstra and @vcunat to be potential reviewers

[ttuegel]

If one appends -DCMAKE_BUILD_TYPE=Debug to cmakeFlags, does that not override the setting made here? In which case, we need only the dontAddBuildType option.

[rasendubi]

You might be interested in #17886

[aneeshusa]

@rasendubi Thanks for linking me in! I've added a commit to address this in my PR #17886 - I think this is a prime example of why sets are a more ergonomic approach to cmakeFlags.

[veprbl]

Can I suggest doing something like:

diff --git a/pkgs/development/tools/build-managers/cmake/setup-hook.sh b/pkgs/development/tools/build-managers/cmake/setup-hook.sh
--- a/pkgs/development/tools/build-managers/cmake/setup-hook.sh
+++ b/pkgs/development/tools/build-managers/cmake/setup-hook.sh
@@ -48,8 +48,14 @@ cmakeConfigurePhase() {
     cmakeFlags="-DCMAKE_INSTALL_INCLUDEDIR=${!outputDev}/include $cmakeFlags"

     # Avoid cmake resetting the rpath of binaries, on make install
-    # And build always Release, to ensure optimisation flags
-    cmakeFlags="-DCMAKE_BUILD_TYPE=Release -DCMAKE_SKIP_BUILD_RPATH=ON $cmakeFlags"
+    cmakeFlags="-DCMAKE_SKIP_BUILD_RPATH=ON $cmakeFlags"
+
+    # Allow to build debug version
+    if [ -z "$dontStrip" ] && [ -z "$separateDebugInfo" ]; then
+      cmakeFlags="-DCMAKE_BUILD_TYPE=Release $cmakeFlags"
+    else
+      cmakeFlags="-DCMAKE_BUILD_TYPE=Debug $cmakeFlags"
+    fi

     echo "cmake flags: $cmakeFlags ${cmakeFlagsArray[@]}"

[rasendubi]

(triage) Isn't this fixed now?

cmakeBuildType is now supported:

nixpkgs/pkgs/development/tools/build-managers/cmake/setup-hook.sh

Line 71 in 92a8711

cmakeFlags="-DCMAKE_BUILD_TYPE=${cmakeBuildType:-Release} -DCMAKE_SKIP_BUILD_RPATH=ON $cmakeFlags"

[Mic92]

I think so.