nixpkgs-suyu/doc/builders/special/makesetuphook.section.md
pennae e42a5c78e7 doc: make sure section depths are consecutive
skipping heading levels (eg from # to ###, or starting at ###) is legal
in pandoc, but not in nixos-render-docs. pandoc acts as though section
levels *were* consecutive, nixos-render-docs prefers to tell people not
to do that kind of thing because it can make documents more fragile.
2023-06-10 18:17:04 +02:00

1.1 KiB

pkgs.makeSetupHook

pkgs.makeSetupHook is a builder that produces hooks that go in to nativeBuildInputs

Usage

pkgs.makeSetupHook {
  name = "something-hook";
  propagatedBuildInputs = [ pkgs.commandsomething ];
  depsTargetTargetPropagated = [ pkgs.libsomething ];
} ./script.sh

setup hook that depends on the hello package and runs hello and @shell@ is substituted with path to bash

pkgs.makeSetupHook {
    name = "run-hello-hook";
    propagatedBuildInputs = [ pkgs.hello ];
    substitutions = { shell = "${pkgs.bash}/bin/bash"; };
    passthru.tests.greeting = callPackage ./test { };
    meta.platforms = lib.platforms.linux;
} (writeScript "run-hello-hook.sh" ''
    #!@shell@
    hello
'')

Attributes

  • name Set the name of the hook.
  • propagatedBuildInputs Runtime dependencies (such as binaries) of the hook.
  • depsTargetTargetPropagated Non-binary dependencies.
  • meta
  • passthru
  • substitutions Variables for substituteAll