diff options
| author | Silvan Mosberger <silvan.mosberger@tweag.io> | 2024-01-05 01:03:37 +0100 |
|---|---|---|
| committer | Silvan Mosberger <silvan.mosberger@tweag.io> | 2024-01-10 19:29:26 +0100 |
| commit | 57afdc545bdc9894754c51265ab993da556915e4 (patch) | |
| tree | be5867408d24fc4b8a0d1452d421d5a6cd24ab72 /pkgs/by-name/README.md | |
| parent | 69fc71a82c0e3acba5045666b48cdaf5adc8d4c3 (diff) | |
| download | nixlib-57afdc545bdc9894754c51265ab993da556915e4.tar nixlib-57afdc545bdc9894754c51265ab993da556915e4.tar.gz nixlib-57afdc545bdc9894754c51265ab993da556915e4.tar.bz2 nixlib-57afdc545bdc9894754c51265ab993da556915e4.tar.lz nixlib-57afdc545bdc9894754c51265ab993da556915e4.tar.xz nixlib-57afdc545bdc9894754c51265ab993da556915e4.tar.zst nixlib-57afdc545bdc9894754c51265ab993da556915e4.zip | |
tests.nixpkgs-check-by-name: Enforce pkgs/by-name for new packages
Diffstat (limited to 'pkgs/by-name/README.md')
| -rw-r--r-- | pkgs/by-name/README.md | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/pkgs/by-name/README.md b/pkgs/by-name/README.md index 948003bb5573..990882aec837 100644 --- a/pkgs/by-name/README.md +++ b/pkgs/by-name/README.md @@ -1,11 +1,9 @@ # Name-based package directories The structure of this directory maps almost directly to top-level package attributes. -This is the recommended way to add new top-level packages to Nixpkgs [when possible](#limitations). +Add new top-level packages to Nixpkgs using this mechanism [whenever possible](#limitations). -Packages found in the named-based structure do not need to be explicitly added to the -`top-level/all-packages.nix` file unless they require overriding the default value -of an implicit attribute (see below). +Packages found in the name-based structure are automatically included, without needing to be added to `all-packages.nix`. However if the implicit attribute defaults need to be changed for a package, this [must still be declared in `all-packages.nix`](#changing-implicit-attribute-defaults). ## Example |