checkpointBuildTools: mkCheckpointedBuild -> mkCheckpointBuild

[bryango]

Description of changes

This PR follows from #167670 (comment) @messemar.

All other functions in checkpointBuildTools are in the form of *CheckpointBuild* without the ed, so we trade the mkCheckpointedBuild name in favor of mkCheckpointBuild for a uniformed look (and link mkCheckpointedBuild to mkCheckpointBuild with a lib.warn "deprecated", although currently there is no such usage yet in nixpkgs).

Also, apply suggestions from @phip1611 and @infinisil that did not make into the last PR.

Note: #167670 (comment) actually does not work: the sourceDifference.patch file gets deleted by rm -r * in the subshell (yeah shell is weird and surprising, as usual!). Instead, we use mktemp to create a temporary file to store the patch. The downside of this is that the patch size is limited by the size of /tmp.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[messemar]

@bryango

Note: #167670 (comment) actually does not work: the sourceDifference.patch file gets deleted by rm -r * in the subshell (yeah shell is weird and surprising, as usual!). Instead, we use mktemp to create a temporary file to store the patch. The downside of this is that the patch size is limited by the size of /tmp.

If the subshell approach does not work, we should keep the previous approach.
Otherwise we introduce a point of failure which is hard to debug actually.

[roberth]

@ofborg build tests.checkpoint-build

Btw maybe that should become tests.checkpointBuildTools

[roberth]

I have no opinion about the copying related change - as long as it works and that's "proven" by the tests.

[bryango]

Note: #167670 (comment) actually does not work: the sourceDifference.patch file gets deleted by rm -r * in the subshell (yeah shell is weird and surprising, as usual!). Instead, we use mktemp to create a temporary file to store the patch. The downside of this is that the patch size is limited by the size of /tmp.

If the subshell approach does not work, we should keep the previous approach. Otherwise we introduce a point of failure which is hard to debug actually.

The current solution is almost identical to the previous implementation, but did solve the issue raised by #167670 (comment). I think it would be good to keep it this way.

[bryango]

ofborg build tests.checkpoint-build

Btw maybe that should become tests.checkpointBuildTools

The test rename is implemented! Waiting for ofborg, I think it knows how to find the new test! Update: no it does not, ofborg manually summoned.

[bryango]

@ofborg build tests.checkpointBuildTools

[infinisil]

(CI failure is unrelated)

[bryango]

Update: CI all green now!

[bryango]

I believe this is ready to be merged now! If there is anything else that you would like me to improve, please don't hesitate to ping me at any time!

[github-actions]

Backport failed for release-23.11, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin release-23.11
git worktree add -d .worktree/backport-279487-to-release-23.11 origin/release-23.11
cd .worktree/backport-279487-to-release-23.11
git switch --create backport-279487-to-release-23.11
git cherry-pick -x df62c3c87f35cd50d6ee20ea92900bb03ad827c9 5f3aad00ffc0a769a1ccc5b3b521221aa5e5d809 d7253bea6d7366987acce31c2c2355ffbdf389b4

[github-actions]

Backport failed for release-23.11, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin release-23.11
git worktree add -d .worktree/backport-279487-to-release-23.11 origin/release-23.11
cd .worktree/backport-279487-to-release-23.11
git switch --create backport-279487-to-release-23.11
git cherry-pick -x df62c3c87f35cd50d6ee20ea92900bb03ad827c9 5f3aad00ffc0a769a1ccc5b3b521221aa5e5d809 d7253bea6d7366987acce31c2c2355ffbdf389b4

[roberth]

Thank you @bryango!

[bryango]

[grammar] Remember to port this:

From a3b90e768b8d43e0efb9cc227153d55609c65999 Mon Sep 17 00:00:00 2001
From: bryango <bryango@users.noreply.github.com>
Date: Thu, 11 Jan 2024 22:52:52 +0800
Subject: [PATCH] checkpointBuildTools.mkCheckpointedBuild: update deprecation
 warning

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
---
 pkgs/build-support/checkpoint-build.nix | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pkgs/build-support/checkpoint-build.nix b/pkgs/build-support/checkpoint-build.nix
index c9bee45005a13a..cc70eddd7ba303 100644
--- a/pkgs/build-support/checkpoint-build.nix
+++ b/pkgs/build-support/checkpoint-build.nix
@@ -85,6 +85,6 @@ rec {
   });
 
   mkCheckpointedBuild = lib.warn
-    "`mkCheckpointedBuild` is deprecated, use `mkCheckpointBuild` instead!"
+    "`mkCheckpointedBuild` is deprecated; use `mkCheckpointBuild` instead."
     mkCheckpointBuild;
 }

... in some future revision.