summary refs log tree commit diff
path: root/nixos/modules/hardware/opengl.nix
diff options
context:
space:
mode:
authorLinus Heckemann <git@sphalerite.org>2018-02-25 16:33:28 +0000
committerLinus Heckemann <git@sphalerite.org>2018-02-25 16:34:34 +0000
commitc255b108188cab1131f50631c923936e3dcceb99 (patch)
tree030a678fa25c08dc8ce2f9821087edd1e58f516b /nixos/modules/hardware/opengl.nix
parenta3c96fd4de3dc95a074919abce71620266d823b9 (diff)
downloadnixpkgs-c255b108188cab1131f50631c923936e3dcceb99.tar
nixpkgs-c255b108188cab1131f50631c923936e3dcceb99.tar.gz
nixpkgs-c255b108188cab1131f50631c923936e3dcceb99.tar.bz2
nixpkgs-c255b108188cab1131f50631c923936e3dcceb99.tar.lz
nixpkgs-c255b108188cab1131f50631c923936e3dcceb99.tar.xz
nixpkgs-c255b108188cab1131f50631c923936e3dcceb99.tar.zst
nixpkgs-c255b108188cab1131f50631c923936e3dcceb99.zip
nixos/opengl: unhide and document enable option
Diffstat (limited to 'nixos/modules/hardware/opengl.nix')
-rw-r--r--nixos/modules/hardware/opengl.nix11
1 files changed, 9 insertions, 2 deletions
diff --git a/nixos/modules/hardware/opengl.nix b/nixos/modules/hardware/opengl.nix
index c2c36f02a14..d9646704e6f 100644
--- a/nixos/modules/hardware/opengl.nix
+++ b/nixos/modules/hardware/opengl.nix
@@ -34,10 +34,17 @@ in
 {
   options = {
     hardware.opengl.enable = mkOption {
-      description = "Whether this configuration requires OpenGL.";
+      description = ''
+        Whether to enable OpenGL drivers. This is needed to enable
+        OpenGL support in X11 systems, as well as for Wayland compositors
+        like sway, way-cooler and Weston. It is enabled by default
+        by the corresponding modules, so you do not usually have to
+        set it yourself, only if there is no module for your wayland
+        compositor of choice. See services.xserver.enable,
+        programs.sway.enable, and programs.way-cooler.enable.
+      '';
       type = types.bool;
       default = false;
-      internal = true;
     };
 
     hardware.opengl.driSupport = mkOption {