Skip to content

Commit

Permalink
doc: add code comment clarifying the meaning of legacyPackages
Browse files Browse the repository at this point in the history
  • Loading branch information
lucperkins authored and cole-h committed Oct 29, 2022
1 parent 1cecfb5 commit 0c738e2
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@
}).nixos.manual.x86_64-linux;
};

# The "legacy" in `legacyPackages` doesn't imply that the packages exposed
# through this attribute are "legacy" packages. Instead, `legacyPackages`
# is used here as a substitute attribute name for `packages`. The problem
# with `packages` is that it makes operations like `nix flake show
# nixpkgs` unusably slow due to the sheer number of packages the Nix CLI
# needs to iterate through. But when the Nix CLI sees a `legacyPackages`
# attribute it displays `omitted` instead of iterating through all
# packages, which keeps `nix flake show` on Nixpkgs reasonably fast,
# though less information rich.
legacyPackages = forAllSystems (system: import ./. { inherit system; });

nixosModules = {
Expand Down

0 comments on commit 0c738e2

Please sign in to comment.