Unverified Commit dccb2645 authored by Maximilian Bosch's avatar Maximilian Bosch
Browse files

linux: remove mentions of extraStructuredConfig & throw error 

PR #431115 changed extraStructuredConfig to structuredExtraConfig to
follow the deprecation warning about `extraConfig`. However,
`extraStructuredConfig` was mentioned in several places in the docs that
weren't addressed. Also, using this would silently fail since the code
in question would still accept the old key.

This patch updates the docs accordingly and throws an error if the
code-path is reached and `extraStructuredConfig` is being used.
parent dfe6a41c

doc/packages/linux.section.md

+1 −1
Original line number Diff line number Diff line
@@ -25,7 +25,7 @@ pkgs.linux_latest.override { 
  ignoreConfigErrors = true;

  autoModules = false;

  kernelPreferBuiltin = true;

  extraStructuredConfig = with lib.kernel; {

  structuredExtraConfig = with lib.kernel; {

    DEBUG_KERNEL = yes;

    FRAME_POINTER = yes;

    KGDB = yes;

nixos/modules/system/boot/kernel.nix

+3 −3
Original line number Diff line number Diff line
@@ -102,7 +102,7 @@ in 
          {

            name = "foo";

            patch = ./foo.patch;

            extraStructuredConfig.FOO = lib.kernel.yes;

            structuredExtraConfig.FOO = lib.kernel.yes;

            features.foo = true;

          }

          {
@@ -127,7 +127,7 @@ in 
                                        # (required, but can be null if only config changes

                                        # are needed)



          extraStructuredConfig = {     # attrset of extra configuration parameters without the CONFIG_ prefix

          structuredExtraConfig = {     # attrset of extra configuration parameters without the CONFIG_ prefix

            FOO = lib.kernel.yes;       # (optional)

          };                            # values should generally be lib.kernel.yes,

                                        # lib.kernel.no or lib.kernel.module
@@ -138,7 +138,7 @@ in 


          extraConfig = "FOO y";        # extra configuration options in string form without the CONFIG_ prefix

                                        # (optional, multiple lines allowed to specify multiple options)

                                        # (deprecated, use extraStructuredConfig instead)

                                        # (deprecated, use structuredExtraConfig instead)

        }

        ```

pkgs/os-specific/linux/kernel/generic.nix

+11 −4
Original line number Diff line number Diff line
@@ -141,7 +141,14 @@ let 
        {

          structuredExtraConfig ? { },

          ...

        }:

        }@args:

        if args ? extraStructuredConfig then

          throw ''

            Passing `extraStructuredConfig` to the Linux kernel (e.g.

            via `boot.kernelPatches` in NixOS) is not supported anymore. Use

            `structuredExtraConfig` instead.

          ''

        else

          {

            settings = structuredExtraConfig;

          }