Unverified Commit 828633d3 authored by Ryan Lahfa's avatar Ryan Lahfa Committed by GitHub
Browse files

Merge pull request #241534 from samueldr/fix/finally-deprecate-boot-loader-raspberrypi

parents 298ff2f2 a6e61a1e

nixos/doc/manual/release-notes/rl-2311.section.md

+2 −0
Original line number Diff line number Diff line
@@ -24,6 +24,8 @@ 


## Backward Incompatibilities {#sec-release-23.11-incompatibilities}



- The `boot.loader.raspberryPi` options have been marked deprecated, with intent for removal for NixOS 24.11. They had a limited use-case, and do not work like people expect. They required either very old installs ([before mid-2019](https://github.com/NixOS/nixpkgs/pull/62462)) or customized builds out of scope of the standard and generic AArch64 support. That option set never supported the Raspberry Pi 4 family of devices.



- `python3.pkgs.sequoia` was removed in favor of `python3.pkgs.pysequoia`. The latter package is based on upstream's dedicated repository for sequoia's Python bindings, where the Python bindings from [gitlab:sequoia-pgp/sequoia](https://gitlab.com/sequoia-pgp/sequoia) were removed long ago.



- `writeTextFile` now requires `executable` to be boolean, values like `null` or `""` will now fail to evaluate.

nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix

+55 −9
Original line number Diff line number Diff line
@@ -52,6 +52,10 @@ in 
          Whether to create files with the system generations in

          `/boot`.

          `/boot/old` will hold files from old generations.



          ::: {.note}

          These options are deprecated, unsupported, and may not work like expected.

          :::

        '';

      };
@@ -67,6 +71,10 @@ in 
          type = types.bool;

          description = lib.mdDoc ''

            Enable using uboot as bootmanager for the raspberry pi.



            ::: {.note}

            These options are deprecated, unsupported, and may not work like expected.

            :::

          '';

        };
@@ -76,6 +84,10 @@ in 
          type = types.int;

          description = lib.mdDoc ''

            Maximum number of configurations in the boot menu.



            ::: {.note}

            These options are deprecated, unsupported, and may not work like expected.

            :::

          '';

        };
@@ -87,12 +99,45 @@ in 
        description = lib.mdDoc ''

          Extra options that will be appended to `/boot/config.txt` file.

          For possible values, see: https://www.raspberrypi.com/documentation/computers/config_txt.html



          ::: {.note}

          These options are deprecated, unsupported, and may not work like expected.

          :::

        '';

      };

    };

  };



  config = mkIf cfg.enable {

  config = mkMerge[

    (mkIf cfg.uboot.enable {

      warnings = [

        ''

          The option set for `boot.loader.raspberrypi.uboot` has been recommended against

          for years, and is now formally deprecated.



          It is possible it already did not work like you expected.



          It never worked on the Raspberry Pi 4 family.



          These options will be removed by NixOS 24.11.

        ''

      ];

    })

    (mkIf cfg.enable {

      warnings = [

        ''

          The option set for `boot.loader.raspberrypi` has been recommended against

          for years, and is now formally deprecated.



          It is possible it already did not work like you expected.



          It never worked on the Raspberry Pi 4 family.



          These options will be removed by NixOS 24.11.

        ''

      ];

    })

    (mkIf cfg.enable {

      assertions = singleton {

        assertion = !pkgs.stdenv.hostPlatform.isAarch64 || cfg.version >= 3;

        message = "Only Raspberry Pi >= 3 supports aarch64.";
@@ -101,5 +146,6 @@ in 
      system.build.installBootLoader = builder;

      system.boot.loader.id = "raspberrypi";

      system.boot.loader.kernelFile = pkgs.stdenv.hostPlatform.linux-kernel.target;

  };

    })

  ];

}