radxa: clarify that the interface may subject to more changes

We might refactor some parts again when we add Amlogic and Allwinner supports.
This commit is contained in:
ZHANG Yuntian
2025-02-07 14:45:09 +08:00
committed by mergify[bot]
parent 0b2e2fe9b3
commit 9d5dedae84

View File

@@ -58,7 +58,7 @@ Below is an annoated flake example to create the initial boot image.
modules = [ modules = [
nixos-hardware.nixosModules.rock-4c-plus # Update the system according to your device. nixos-hardware.nixosModules.rock-4c-plus # Update the system according to your device.
disko.nixosModules.disko # disko usage is optional in the running system, but we need it to generate the initial boot image. disko.nixosModules.disko # disko usage is optional in the running system, but we need it to generate the initial boot image.
"${nixos-hardware}/radxa/disko.nix" # Common Radxa Disko profile. it is system-agnostic. "${nixos-hardware}/radxa/disko.nix" # Common Radxa Disko profile. It is system-agnostic.
{ {
disko = { disko = {
imageBuilder = { imageBuilder = {
@@ -92,3 +92,13 @@ Below is an annoated flake example to create the initial boot image.
}; };
} }
``` ```
For most of the supported products, you only need to change the device module (
i.e. `nixos-hardware.nixosModules.rock-4c-plus`) to match the one you are using.
## Known issues
* Currently, the `hardware.radxa` module and Radxa-maintained SoC vendor modules
(eg. `hardware.rockchip`) are tightly coupled and not intended for end-user to
use. Those options are currently used internally for hardware enablement, and
end-user should not need to modify them. Consider those interfaces **unstable**.