Skip to content

doc: fixup doc/build-helpers references #328151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roberth merged 1 commit into from
Jul 18, 2024
Merged

doc: fixup doc/build-helpers references #328151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions pkgs/build-support/testers/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{ 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 = [
Expand All @@ -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,
Expand Down Expand Up @@ -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",
Expand All @@ -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;
Expand All @@ -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;
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pkgs/build-support/testers/lychee.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ? { },
Expand Down
2 changes: 1 addition & 1 deletion pkgs/build-support/trivial-builders/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down