diff options
author | Profpatsch <mail@profpatsch.de> | 2020-06-20 14:02:35 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-06-20 14:02:35 +0200 |
commit | cc0bf76d2fac84f5bb9ba35dc1a00bf615b86212 (patch) | |
tree | be1c1fe6834cec3532073130180a02c39b126acf | |
parent | 2fd146f6aeb8bb3b9942774ada77407f333a5ce3 (diff) | |
parent | 2c282fb537c6917004d1193e44cedee64790dabe (diff) |
Merge pull request #91160 from Profpatsch/nixos-hardware-merge
Merge nixos-hardware into nixpkgs under `/nixos/hardware`
112 files changed, 3927 insertions, 0 deletions
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 5376d51a6178..9b2fdd85c31d 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -55,6 +55,15 @@ # NixOS integration test driver /nixos/lib/test-driver @tfc +# NixOS hardware descriptions +/nixos/hardware/beagleboard/pocketbeagle @yegortimoshenko +/nixos/hardware/dell/xps/13-9370 @moredread +/nixos/hardware/dell/xps/13-9380 @kalbasit +/nixos/hardware/lenovo/thinkpad/x230 @makefu @yegortimoshenko +/nixos/hardware/lenovo/thinkpad/x250 @Mic92 +/nixos/hardware/pcengines/apu @yegortimoshenko +/nixos/hardware/purism/librem/13v3 @yegortimoshenko + # Updaters ## update.nix /maintainers/scripts/update.nix @jtojnar diff --git a/nixos/hardware/CODEOWNERS b/nixos/hardware/CODEOWNERS new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/nixos/hardware/CODEOWNERS diff --git a/nixos/hardware/CONTRIBUTING.md b/nixos/hardware/CONTRIBUTING.md new file mode 100644 index 000000000000..ea468923ae10 --- /dev/null +++ b/nixos/hardware/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Writing profiles + +When setting an option, use `lib.mkDefault` unless: +- The option *must* be set and the user should get an error if they try to override it. +- The setting should merge with the user's settings (typical for list or set options). + +For example: + +```nix +{ lib }: { + # Using mkDefault, because the user might want to disable tlp + services.tlp.enable = lib.mkDefault true; + # No need to use mkDefault, because the setting will merge with the user's setting + boot.kernelModules = [ "tmp_smapi" ]; +} +``` + +Try to avoid "opinionated" settings relating to optional features like sound, bluetooth, choice of bootloader etc. + +Where possible, use module imports to share code between similar hardware variants. + +# Performance + +Profiles should favor usability and stability, so performance improvements should either be conservative or +be guarded behind additional NixOS module options. + +If it makes sense to have a performance-focussed config, it can be declared in a separate profile. + +# Testing + +Because profiles can only be tested with the appropriate hardware, quality assurance is up to *you*. |