diff options
| author | Adam Joseph <54836058+amjoseph-nixpkgs@users.noreply.github.com> | 2023-04-24 04:30:37 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-24 04:30:37 +0000 |
| commit | 467ee31e58ccb79476d815f4131cb283cecd9560 (patch) | |
| tree | bace89604a0d4e69f7085600c48ed07d3f6cbd57 /doc/stdenv/meta.chapter.md | |
| parent | 19d48a925778a524a970ca06cabc45ade3f82474 (diff) | |
| download | nixpkgs-467ee31e58ccb79476d815f4131cb283cecd9560.tar nixpkgs-467ee31e58ccb79476d815f4131cb283cecd9560.tar.gz nixpkgs-467ee31e58ccb79476d815f4131cb283cecd9560.tar.bz2 nixpkgs-467ee31e58ccb79476d815f4131cb283cecd9560.tar.lz nixpkgs-467ee31e58ccb79476d815f4131cb283cecd9560.tar.xz nixpkgs-467ee31e58ccb79476d815f4131cb283cecd9560.tar.zst nixpkgs-467ee31e58ccb79476d815f4131cb283cecd9560.zip | |
Update doc/stdenv/meta.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Diffstat (limited to 'doc/stdenv/meta.chapter.md')
| -rw-r--r-- | doc/stdenv/meta.chapter.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/stdenv/meta.chapter.md b/doc/stdenv/meta.chapter.md index f4e9a5d4f9b..6f58648cdf5 100644 --- a/doc/stdenv/meta.chapter.md +++ b/doc/stdenv/meta.chapter.md @@ -182,7 +182,8 @@ meta.hydraPlatforms = []; ### `broken` {#var-meta-broken} -If set to `true`, the package is marked as "broken", meaning that it won’t show up in `nix-env -qa`, and cannot be built or installed unless the environment variable `NIXPKGS_ALLOW_BROKEN` is set. Such unconditionally-broken packages should be removed from Nixpkgs eventually unless they are fixed. +If set to `true`, the package is marked as "broken", meaning that it won’t show up in [search.nixos.org](https://search.nixos.org/packages), and cannot be built or installed unless the environment variable [`NIXPKGS_ALLOW_BROKEN`](#opt-allowBroken) is set. +Such unconditionally-broken packages should be removed from Nixpkgs eventually unless they are fixed. The value of this attribute can depend on a package's arguments, including `stdenv`. This means that `broken` can be used to express constraints such as "does not cross compile" (`meta.broken = !(stdenv.buildPlatform.canExecute stdenv.hostPlatform)`) or "broken if all of a certain set of its dependencies are broken". This makes `broken` strictly more powerful than `meta.badPlatforms`. However `meta.availableOn` currently examines only `meta.platforms` and `meta.badPlatforms`, so `meta.broken` does not influence the default values for optional dependencies. |