kernel: add a warning/note at the top of common-config so that people would hopefully stop breaking the older kernels

This commit is contained in:
Jan Malakhovski 2015-03-24 21:34:54 +00:00
parent 5990cce95f
commit 89bfacdf90

View File

@ -1,3 +1,21 @@
/*
WARNING/NOTE: whenever you want to add an option here you need to
either
* mark it as an optional one with `?` suffix,
* or make sure it works for all the versions in nixpkgs,
* or check for which kernel versions it will work (using kernel
changelog, google or whatever) and mark it with `versionOlder` or
`versionAtLeast`.
Then do test your change by building all the kernels (or at least
their configs) in nixpkgs or else you will guarantee lots and lots
of pain to users trying to switch to an older kernel because of some
hardware problems with a new one.
*/
{ stdenv, version, kernelPlatform, extraConfig, features }:
with stdenv.lib;