doc: fixup doc/build-helpers references

This commit is contained in:
Ivan Trubach 2024-07-18 14:15:53 +03:00
parent 603bb14479
commit c2e1be3be0
3 changed files with 14 additions and 14 deletions

View File

@ -1,12 +1,12 @@
{ pkgs, pkgsLinux, buildPackages, lib, callPackage, runCommand, stdenv, substituteAll, testers }: { 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 # 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; inherit (callPackage ./lychee.nix {}) lycheeLinkCheck;
# See https://nixos.org/manual/nixpkgs/unstable/#tester-testBuildFailure # 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: { testBuildFailure = drv: drv.overrideAttrs (orig: {
builder = buildPackages.bash; builder = buildPackages.bash;
args = [ args = [
@ -16,11 +16,11 @@
}); });
# See https://nixos.org/manual/nixpkgs/unstable/#tester-testEqualDerivation # 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 { }; testEqualDerivation = callPackage ./test-equal-derivation.nix { };
# See https://nixos.org/manual/nixpkgs/unstable/#tester-testEqualContents # See https://nixos.org/manual/nixpkgs/unstable/#tester-testEqualContents
# or doc/builders/testers.chapter.md # or doc/build-helpers/testers.chapter.md
testEqualContents = { testEqualContents = {
assertion, assertion,
actual, actual,
@ -58,7 +58,7 @@
''; '';
# See https://nixos.org/manual/nixpkgs/unstable/#tester-testVersion # See https://nixos.org/manual/nixpkgs/unstable/#tester-testVersion
# or doc/builders/testers.chapter.md # or doc/build-helpers/testers.chapter.md
testVersion = testVersion =
{ package, { package,
command ? "${package.meta.mainProgram or package.pname or package.name} --version", command ? "${package.meta.mainProgram or package.pname or package.name} --version",
@ -81,8 +81,8 @@
fi fi
''; '';
# See doc/builders/testers.chapter.md or # See https://nixos.org/manual/nixpkgs/unstable/#tester-invalidateFetcherByDrvHash
# https://nixos.org/manual/nixpkgs/unstable/#tester-invalidateFetcherByDrvHash # or doc/build-helpers/testers.chapter.md
invalidateFetcherByDrvHash = f: args: invalidateFetcherByDrvHash = f: args:
let let
drvPath = (f args).drvPath; drvPath = (f args).drvPath;
@ -98,8 +98,8 @@
else salted; else salted;
in checked; in checked;
# See doc/builders/testers.chapter.md or # See https://nixos.org/manual/nixpkgs/unstable/#tester-runNixOSTest
# https://nixos.org/manual/nixpkgs/unstable/#tester-runNixOSTest # or doc/build-helpers/testers.chapter.md
runNixOSTest = runNixOSTest =
let nixos = import ../../../nixos/lib { let nixos = import ../../../nixos/lib {
inherit lib; inherit lib;
@ -114,8 +114,8 @@
node.pkgs = pkgsLinux; node.pkgs = pkgsLinux;
}; };
# See doc/builders/testers.chapter.md or # See https://nixos.org/manual/nixpkgs/unstable/#tester-invalidateFetcherByDrvHash
# https://nixos.org/manual/nixpkgs/unstable/#tester-invalidateFetcherByDrvHash # or doc/build-helpers/testers.chapter.md
nixosTest = nixosTest =
let let
/* The nixos/lib/testing-python.nix module, preapplied with arguments that /* The nixos/lib/testing-python.nix module, preapplied with arguments that

View File

@ -19,7 +19,7 @@ let
''; '';
# See https://nixos.org/manual/nixpkgs/unstable/#tester-lycheeLinkCheck # See https://nixos.org/manual/nixpkgs/unstable/#tester-lycheeLinkCheck
# or doc/builders/testers.chapter.md # or doc/build-helpers/testers.chapter.md
lycheeLinkCheck = { lycheeLinkCheck = {
site, site,
remap ? { }, remap ? { },

View File

@ -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 # See https://nixos.org/manual/nixpkgs/unstable/#sec-pkgs.makeSetupHook
makeSetupHook = makeSetupHook =
{ name ? lib.warn "calling makeSetupHook without passing a name is deprecated." "hook" { name ? lib.warn "calling makeSetupHook without passing a name is deprecated." "hook"