Unverified Commit 53ec3635 authored by Robert Hensing's avatar Robert Hensing Committed by GitHub
Browse files

Merge pull request #328151 from tie/doc-build-helpers-references 

doc: fixup doc/build-helpers references
parents 57fe4f50 c2e1be3b

pkgs/build-support/testers/default.nix

+12 −12
Original line number Diff line number Diff line 
{ pkgs, pkgsLinux, buildPackages, lib, callPackage, runCommand, stdenv, substituteAll, testers }:

# Documentation is in doc/builders/testers.chapter.md

# Documentation is in doc/build-helpers/testers.chapter.md

{

  # See https://nixos.org/manual/nixpkgs/unstable/#tester-lycheeLinkCheck

  # or doc/builders/testers.chapter.md

  # or doc/build-helpers/testers.chapter.md

  inherit (callPackage ./lychee.nix {}) lycheeLinkCheck;



  # See https://nixos.org/manual/nixpkgs/unstable/#tester-testBuildFailure

  # or doc/builders/testers.chapter.md

  # or doc/build-helpers/testers.chapter.md

  testBuildFailure = drv: drv.overrideAttrs (orig: {

    builder = buildPackages.bash;

    args = [
@@ -16,11 +16,11 @@ 
  });



  # See https://nixos.org/manual/nixpkgs/unstable/#tester-testEqualDerivation

  # or doc/builders/testers.chapter.md

  # or doc/build-helpers/testers.chapter.md

  testEqualDerivation = callPackage ./test-equal-derivation.nix { };



  # See https://nixos.org/manual/nixpkgs/unstable/#tester-testEqualContents

  # or doc/builders/testers.chapter.md

  # or doc/build-helpers/testers.chapter.md

  testEqualContents = {

    assertion,

    actual,
@@ -58,7 +58,7 @@ 
  '';



  # See https://nixos.org/manual/nixpkgs/unstable/#tester-testVersion

  # or doc/builders/testers.chapter.md

  # or doc/build-helpers/testers.chapter.md

  testVersion =

    { package,

      command ? "${package.meta.mainProgram or package.pname or package.name} --version",
@@ -81,8 +81,8 @@ 
      fi

    '';



  # See doc/builders/testers.chapter.md or

  # https://nixos.org/manual/nixpkgs/unstable/#tester-invalidateFetcherByDrvHash

  # See https://nixos.org/manual/nixpkgs/unstable/#tester-invalidateFetcherByDrvHash

  # or doc/build-helpers/testers.chapter.md

  invalidateFetcherByDrvHash = f: args:

    let

      drvPath = (f args).drvPath;
@@ -98,8 +98,8 @@ 
        else salted;

    in checked;



  # See doc/builders/testers.chapter.md or

  # https://nixos.org/manual/nixpkgs/unstable/#tester-runNixOSTest

  # See https://nixos.org/manual/nixpkgs/unstable/#tester-runNixOSTest

  # or doc/build-helpers/testers.chapter.md

  runNixOSTest =

    let nixos = import ../../../nixos/lib {

      inherit lib;
@@ -114,8 +114,8 @@ 
          node.pkgs = pkgsLinux;

        };



  # See doc/builders/testers.chapter.md or

  # https://nixos.org/manual/nixpkgs/unstable/#tester-invalidateFetcherByDrvHash

  # See https://nixos.org/manual/nixpkgs/unstable/#tester-invalidateFetcherByDrvHash

  # or doc/build-helpers/testers.chapter.md

  nixosTest =

    let

      /* The nixos/lib/testing-python.nix module, preapplied with arguments that

pkgs/build-support/testers/lychee.nix

+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ let 
    '';



  # See https://nixos.org/manual/nixpkgs/unstable/#tester-lycheeLinkCheck

  # or doc/builders/testers.chapter.md

  # or doc/build-helpers/testers.chapter.md

  lycheeLinkCheck = {

    site,

    remap ? { },

pkgs/build-support/trivial-builders/default.nix

+1 −1
Original line number Diff line number Diff line
@@ -586,7 +586,7 @@ rec { 
  '';





  # Docs in doc/builders/special/makesetuphook.section.md

  # Docs in doc/build-helpers/special/makesetuphook.section.md

  # See https://nixos.org/manual/nixpkgs/unstable/#sec-pkgs.makeSetupHook

  makeSetupHook =

    { name ? lib.warn "calling makeSetupHook without passing a name is deprecated." "hook"