Skip to content

Commit ab1afee

Browse files
authored
docs(core): main description got outdated (#346)
#339 updated some things. Did not update these descriptions.
1 parent c53fd67 commit ab1afee

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

lib/core.nix

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
lib,
55
wlib,
66
extendModules,
7-
# NOTE: makes sure builderFunction and wrapperFunction get name from _module.args
7+
# NOTE: makes sure builderFunction gets name from _module.args
88
name ? null,
99
...
1010
}@args:
@@ -155,11 +155,12 @@ in
155155
156156
They are somewhat minimal by design. They pertain to building the derivation, not the wrapper script.
157157
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
159160
160-
The default `wrapperFunction` is null.
161+
`buildCommand` is also empty by default.
161162
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.
163164
164165
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!
165166
@@ -423,7 +424,7 @@ in
423424
config.package.pname or config.package.name
424425
or (throw "config.binName was not able to be detected!");
425426
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`
427428
428429
If not specified, the default name from the package will be used.
429430
'';
@@ -459,13 +460,13 @@ in
459460
type = lib.types.str;
460461
readOnly = true;
461462
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`";
463464
};
464465
placeholder = lib.mkOption {
465466
type = lib.types.str;
466467
readOnly = true;
467468
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.";
469470
};
470471
relPath = lib.mkOption {
471472
type = lib.types.str;

0 commit comments

Comments
 (0)