From 60d3bae3845050d36328fbfc9a0e95b82a25f2f1 Mon Sep 17 00:00:00 2001 From: mexisme Date: Mon, 22 Jul 2024 00:40:46 +1200 Subject: [PATCH] Add deprecation explanation --- asus/zephyrus/ga402x/ATTR-SET-DEPRECATION.md | 16 ++++++++++++++++ asus/zephyrus/ga402x/default.nix | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 asus/zephyrus/ga402x/ATTR-SET-DEPRECATION.md diff --git a/asus/zephyrus/ga402x/ATTR-SET-DEPRECATION.md b/asus/zephyrus/ga402x/ATTR-SET-DEPRECATION.md new file mode 100644 index 0000000..21d3d1e --- /dev/null +++ b/asus/zephyrus/ga402x/ATTR-SET-DEPRECATION.md @@ -0,0 +1,16 @@ +# Deprecation of //asus/zephyrus/ga402x/default.nix + +Background: +The `asus-zephyrus-ga402x` provides an attr-set with `amdgpu` and `nvidia` entries, to allow users +to choose whether to enable only the AMD-GPU driver, or also enable the NVidia driver with (by +default) Prime enabled. + +However, this attr-set style seems to be broken by [PR #1046](https://github.com/NixOS/nixos-hardware/pull/1046), +which exports modules as paths, instead. +That change seems to cause an error of "value is a path while a set was expected". + +[PR #1053](https://github.com/NixOS/nixos-hardware/pull/1053): +- Replaced `asus-zephyrus-ga402x.amdgpu` with a `asus-zephyrus-ga402x-amdgpu` entry. +- Replaced `asus-zephyrus-ga402x.nvidia` with a `asus-zephyrus-ga402x-nvidia` entry. +- Made `asus-zephyrus-ga402x` throw a deprecation error. +- [FIXES: #1052](https://github.com/NixOS/nixos-hardware/issues/1052) diff --git a/asus/zephyrus/ga402x/default.nix b/asus/zephyrus/ga402x/default.nix index a77e24d..e4e681e 100644 --- a/asus/zephyrus/ga402x/default.nix +++ b/asus/zephyrus/ga402x/default.nix @@ -4,7 +4,7 @@ assertions = [ { assertion = false; - message = "Importing asus/zephyrus/ga402x/ (default.nix) directly is deprecated! #TODO: More details"; + message = "Importing asus/zephyrus/ga402x/ (default.nix) directly is deprecated! See https://github.com/NixOS/nixos-hardware/blob/master/asus/zephyrus/ga402x/ATTR-SET-DEPRECATION.md for more details"; } ]; }