Documentation: sec-pkgs.makeSetupHook-usage-example unclear

[MathiasSven]

Problem

The makeSetupHook-usage-example in the nixpkgs manual has this example:

nixpkgs/doc/build-helpers/special/makesetuphook.section.md

Lines 17 to 28 in 6ac8e04

	```nix
	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
	'')
	```

But it isn't clear how this is supposed to be used. propagatedBuildInputs suggests that the hook is self-contained in its dependency, but this example fails to build:

{ pkgs ? import <nixpkgs> { } }:

let
  inherit (pkgs) writeScript;
  myHook = pkgs.makeSetupHook {
      name = "run-hello-hook";
      propagatedBuildInputs = [ pkgs.hello ];
      substitutions = { shell = "${pkgs.bash}/bin/bash"; };
  } (writeScript "run-hello-hook.sh" ''
      #!@shell@
      hello
  '');
in
  pkgs.stdenv.mkDerivation {
    name = "foobar-test";
    dontUnpack = true;
    nativeBuildInputs = [ myHook ];
    dontBuild = true;
    installPhase = ''
      echo "foobar" > $out
    '';
  }

With hello: command not found

@Artturin

Proposal

Give a minimal example usage of it.

Checklist

• checked latest Nixpkgs manual (source) and latest NixOS manual (source)
• checked open documentation issues for possible duplicates
• checked open documentation pull requests for possible solutions

---

Add a 👍 reaction to issues you find important.

[Artturin]

#320107