wroclaw-git-backups/nix
1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-06-25 10:41:16 +02:00
Code Activity

Merge pull request #12590 from NixOS/mergify/bp/2.27-maintenance/pr-12582

Browse source 
packaging/everything.nix: Use a multi-output derivation (backport #12582)
This commit is contained in:
mergify[bot] 2025-03-02 13:16:07 +00:00 • committed by GitHub
commit 7e61e9650c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 122 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

200
packaging/everything.nix
View file

@ -1,6 +1,7 @@
{ {
lib, lib,
stdenv, stdenv,
lndir,
buildEnv, buildEnv,
nix-util, nix-util,
@ -38,7 +39,6 @@
nix-perl-bindings, nix-perl-bindings,
testers, testers,
runCommand,
}: }:
let let
@ -119,92 +119,136 @@ let
}; };
in in
(buildEnv { stdenv.mkDerivation (finalAttrs: {
name = "nix-${nix-cli.version}"; pname = "nix";
paths = [ version = nix-cli.version;
nix-cli
nix-manual.man /**
This package uses a multi-output derivation, even though some outputs could
have been provided directly by the constituent component that provides it.
This is because not all tooling handles packages composed of arbitrary
outputs yet. This includes nix itself, https://github.com/NixOS/nix/issues/6507.
`devdoc` is also available, but not listed here, because this attribute is
not an output of the same derivation that provides `out`, `dev`, etc.
*/
outputs = [
"out"
"dev"
"doc"
"man"
]; ];
meta.mainProgram = "nix"; /**
}).overrideAttrs Unpacking is handled in this package's constituent components
( */
finalAttrs: prevAttrs: { dontUnpack = true;
doCheck = true; /**
doInstallCheck = true; Building is handled in this package's constituent components
*/
dontBuild = true;
checkInputs = /**
[ `doCheck` controles whether tests are added as build gate for the combined package.
# Make sure the unit tests have passed This includes both the unit tests and the functional tests, but not the
nix-util-tests.tests.run integration tests that run in CI (the flake's `hydraJobs` and some of the `checks`).
nix-store-tests.tests.run */
nix-expr-tests.tests.run doCheck = true;
nix-fetchers-tests.tests.run
nix-flake-tests.tests.run
# Make sure the functional tests have passed /**
nix-functional-tests `fixupPhase` currently doesn't understand that a symlink output isn't writable.
# dev bundle is ok We don't compile or link anything in this derivation, so fixups aren't needed.
# (checkInputs must be empty paths??) */
(runCommand "check-pkg-config" { checked = dev.tests.pkg-config; } "mkdir $out") dontFixup = true;
]
++ lib.optionals
(!stdenv.hostPlatform.isStatic && stdenv.buildPlatform.canExecute stdenv.hostPlatform)
[
# Perl currently fails in static build
# TODO: Split out tests into a separate derivation?
nix-perl-bindings
];
passthru = prevAttrs.passthru // {
inherit (nix-cli) version;
/** checkInputs =
These are the libraries that are part of the Nix project. They are used [
by the Nix CLI and other tools. # Make sure the unit tests have passed
nix-util-tests.tests.run
nix-store-tests.tests.run
nix-expr-tests.tests.run
nix-fetchers-tests.tests.run
nix-flake-tests.tests.run
If you need to use these libraries in your project, we recommend to use # Make sure the functional tests have passed
the `-c` C API libraries exclusively, if possible. nix-functional-tests
]
++ lib.optionals
(!stdenv.hostPlatform.isStatic && stdenv.buildPlatform.canExecute stdenv.hostPlatform)
[
# Perl currently fails in static build
# TODO: Split out tests into a separate derivation?
nix-perl-bindings
];
We also recommend that you build the complete package to ensure that the unit tests pass. nativeBuildInputs = [
You could do this in CI, or by passing it in an unused environment variable. e.g in a `mkDerivation` call: lndir
];
```nix installPhase =
buildInputs = [ nix.libs.nix-util-c nix.libs.nix-store-c ]; let
# Make sure the nix libs we use are ok devPaths = lib.mapAttrsToList (_k: lib.getDev) finalAttrs.finalPackage.libs;
unusedInputsForTests = [ nix ]; in
disallowedReferences = nix.all; ''
``` mkdir -p $out $dev $doc $man
*/
inherit libs;
tests = prevAttrs.passthru.tests or { } // { # Merged outputs
# TODO: create a proper fixpoint and: lndir ${nix-cli} $out
# pkg-config = for lib in ${lib.escapeShellArgs devPaths}; do
# testers.hasPkgConfigModules { lndir $lib $dev
# package = finalPackage; done
# };
};
/** # Forwarded outputs
A derivation referencing the `dev` outputs of the Nix libraries. ln -s ${nix-manual} $doc
*/ ln -s ${nix-manual.man} $man
inherit dev; '';
inherit devdoc;
doc = nix-manual; passthru = {
outputs = [ inherit (nix-cli) version;
"out"
"dev" /**
"devdoc" These are the libraries that are part of the Nix project. They are used
"doc" by the Nix CLI and other tools.
];
all = lib.attrValues ( If you need to use these libraries in your project, we recommend to use
lib.genAttrs finalAttrs.passthru.outputs (outName: finalAttrs.finalPackage.${outName}) the `-c` C API libraries exclusively, if possible.
);
We also recommend that you build the complete package to ensure that the unit tests pass.
You could do this in CI, or by passing it in an unused environment variable. e.g in a `mkDerivation` call:
```nix
buildInputs = [ nix.libs.nix-util-c nix.libs.nix-store-c ];
# Make sure the nix libs we use are ok
unusedInputsForTests = [ nix ];
disallowedReferences = nix.all;
```
*/
inherit libs;
/**
Developer documentation for `nix`, in `share/doc/nix/{internal,external}-api/`.
This is not a proper output; see `outputs` for context.
*/
inherit devdoc;
/**
Extra tests that test this package, but do not run as part of the build.
See <https://nixos.org/manual/nixpkgs/stable/index.html#var-passthru-tests>
*/
tests = {
pkg-config = testers.hasPkgConfigModules {
package = finalAttrs.finalPackage;
}; };
meta = prevAttrs.meta // { };
description = "The Nix package manager"; };
pkgConfigModules = dev.meta.pkgConfigModules;
}; meta = {
} mainProgram = "nix";
) description = "The Nix package manager";
pkgConfigModules = dev.meta.pkgConfigModules;
};
})