From ae8d3209360b99537ee9f77fc6ed023faddcc999 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Fri, 21 Nov 2025 22:00:48 +0100 Subject: [PATCH] docs(bundlers): Improve option description - Add test location comment - Update URL to current nix.dev docs - Explain what bundlers are and how to use them --- extras/bundlers.nix | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/extras/bundlers.nix b/extras/bundlers.nix index c4197e2..e83bb5f 100644 --- a/extras/bundlers.nix +++ b/extras/bundlers.nix @@ -1,3 +1,5 @@ +# Tests in: ../dev/tests/eval-tests.nix (bundlersExample) + { lib , flake-parts-lib , ... @@ -19,9 +21,14 @@ mkTransposedPerSystemModule { type = types.lazyAttrsOf (types.functionTo types.package); default = { }; description = '' - An attribute set of bundlers to be used by [`nix bundle`](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-bundle.html). + An attribute set of bundlers to be used by [`nix bundle`](https://nix.dev/manual/nix/latest/command-ref/new-cli/nix3-bundle.html). - `nix bundle --bundler .#` will bundle using the bundler `bundlers.`. + Bundlers are functions that accept a derivation and return a derivation. + They package application closures into formats usable outside the Nix store. + + `nix bundle --bundler .# .#` bundles `` using bundler ``. + + Define a `default` bundler to use `nix bundle --bundler .#`. ''; }; file = ./bundlers.nix;