|
4 | 4 | lib, |
5 | 5 | wlib, |
6 | 6 | extendModules, |
7 | | - # NOTE: makes sure builderFunction and wrapperFunction get name from _module.args |
| 7 | + # NOTE: makes sure builderFunction gets name from _module.args |
8 | 8 | name ? null, |
9 | 9 | ... |
10 | 10 | }@args: |
|
155 | 155 |
|
156 | 156 | They are somewhat minimal by design. They pertain to building the derivation, not the wrapper script. |
157 | 157 |
|
158 | | - The default `builderFunction` value provides no options. |
| 158 | + The default `builderFunction` value is `{ buildCommand, ... }: buildCommand;`, |
| 159 | + which just runs the result of `buildCommand`, and the non-problematic stdenv phases by default |
159 | 160 |
|
160 | | - The default `wrapperFunction` is null. |
| 161 | + `buildCommand` is also empty by default. |
161 | 162 |
|
162 | | - `wlib.modules.default` provides great values for these options, and creates many more for you to use. |
| 163 | + `wlib.modules.default` provides great starting values for these options, and creates many more for you to use. |
163 | 164 |
|
164 | 165 | But you may want to wrap your package via different means, provide different options, or provide modules for others to use to help do those things! |
165 | 166 |
|
|
423 | 424 | config.package.pname or config.package.name |
424 | 425 | or (throw "config.binName was not able to be detected!"); |
425 | 426 | description = '' |
426 | | - The name of the binary output by `wrapperFunction` to `config.wrapperPaths.placeholder` |
| 427 | + The name of the binary to be output to `config.wrapperPaths.placeholder` |
427 | 428 |
|
428 | 429 | If not specified, the default name from the package will be used. |
429 | 430 | ''; |
|
459 | 460 | type = lib.types.str; |
460 | 461 | readOnly = true; |
461 | 462 | default = "${config.package}" + lib.optionalString (config.exePath != null) "/${config.exePath}"; |
462 | | - description = "The path which is to be wrapped by the wrapperFunction implementation"; |
| 463 | + description = "The path which is to be wrapped by the result of `buildCommand`"; |
463 | 464 | }; |
464 | 465 | placeholder = lib.mkOption { |
465 | 466 | type = lib.types.str; |
466 | 467 | readOnly = true; |
467 | 468 | default = "${placeholder config.outputName}${config.wrapperPaths.relPath}"; |
468 | | - description = "The path which the wrapperFunction implementation is to output its result to."; |
| 469 | + description = "The path which the result of `buildCommand` is to output its result to."; |
469 | 470 | }; |
470 | 471 | relPath = lib.mkOption { |
471 | 472 | type = lib.types.str; |
|
0 commit comments