From 89bfacdf90fff0dde857c5b0e29b73042ec1d4c7 Mon Sep 17 00:00:00 2001 From: Jan Malakhovski Date: Tue, 24 Mar 2015 21:34:54 +0000 Subject: kernel: add a warning/note at the top of common-config so that people would hopefully stop breaking the older kernels --- pkgs/os-specific/linux/kernel/common-config.nix | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'pkgs/os-specific/linux/kernel/common-config.nix') diff --git a/pkgs/os-specific/linux/kernel/common-config.nix b/pkgs/os-specific/linux/kernel/common-config.nix index e6d45af7c59..002c2997cd6 100644 --- a/pkgs/os-specific/linux/kernel/common-config.nix +++ b/pkgs/os-specific/linux/kernel/common-config.nix @@ -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; -- cgit 1.4.1