all-packages.nix: introductory top-level comment

Many newcomers are baffled as to how all-packages.nix is structured.
This comment should provide clarification.
This commit is contained in:
Profpatsch 2016-07-23 06:51:38 +02:00
parent 99bfa00bf6
commit cbdfecc52b

View File

@ -1,3 +1,10 @@
/* The top-level package collection of nixpkgs.
* It is sorted by categories corresponding to the folder names
* in the /pkgs folder. Inside the categories packages are roughly
* sorted by alphabet, but strict sorting has been long lost due
* to merges. Please use the full-text search of your editor. ;)
* Hint: ### starts category names.
*/
{ system, bootStdenv, noSysDirs, config, crossSystem, platform, lib
, pkgsWithOverrides
, ... }: