Merge pull request #322 from hercules-ci/bundlers
docs(bundlers): Improve option description
This commit is contained in:
commit
2cccadc735
1 changed files with 9 additions and 2 deletions
|
|
@ -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 .#<name>` <derivation> will bundle <derivation> using the bundler `bundlers.<name>`.
|
||||
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 .#<name> .#<package>` bundles `<package>` using bundler `<name>`.
|
||||
|
||||
Define a `default` bundler to use `nix bundle --bundler .#`.
|
||||
'';
|
||||
};
|
||||
file = ./bundlers.nix;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue