raspberrypi/4: fix many option rendering

raspberry-pi/4/audio.nix

@@ -11,9 +11,7 @@ in
 {
   options.hardware = {
     raspberry-pi."4".audio = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "configuration for audio";
-        configuration for audio
-      '';
     };
   };
 

raspberry-pi/4/backlight.nix

@@ -6,9 +6,7 @@ in
 {
   options.hardware = {
     raspberry-pi."4".backlight = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "the backlight support for the Raspberry Pi official Touch Display";
-        Enable the backlight support for the Raspberry Pi official Touch Display
-      '';
     };
   };
 

raspberry-pi/4/bluetooth.nix

@@ -6,9 +6,7 @@ in
 {
   options.hardware = {
     raspberry-pi."4".bluetooth = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "configuration for bluetooth";
-        configuration for bluetooth
-      '';
     };
   };
 

raspberry-pi/4/digi-amp-plus.nix

@@ -6,15 +6,13 @@ in
 {
   options.hardware = {
     raspberry-pi."4".digi-amp-plus = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "support for the IQaudIO DigiAMP+ Hat";
-        support for the IQaudIO DigiAMP+ Hat.
-      '';
 
       unmuteAmp = lib.mkOption {
         type = lib.types.bool;
         default = false;
         description = ''
-          "one-shot" unmute when kernel module first loads.
+          Whether to "one-shot" unmute when kernel module first loads.
         '';
       };
 

raspberry-pi/4/dwc2.nix

@@ -6,7 +6,11 @@ in
 {
   options.hardware = {
     raspberry-pi."4".dwc2 = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkOption {
+        type = lib.types.bool;
+        default = false;
+        example = true;
+        description = ''
           Enable the UDC controller to support USB OTG gadget functions.
 
           In order to verify that this works, connect the Raspberry Pi with
@@ -24,6 +28,7 @@ in
           guides on how to test them, please refer to:
           https://www.kernel.org/doc/Documentation/usb/gadget-testing.txt
         '';
+      };
       dr_mode = lib.mkOption {
         type = lib.types.enum [
           "host"

raspberry-pi/4/i2c.nix

@@ -31,28 +31,32 @@ in
 {
   options.hardware.raspberry-pi."4" = {
     i2c0 = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "" // {
+        description = ''
           Turn on the VideoCore I2C bus (maps to /dev/i2c-22) and enable access from the i2c group.
           After a reboot, i2c-tools (e.g. i2cdetect -F 22) should work for root or any user in i2c.
         '';
+      };
       frequency = lib.mkOption {
         type = lib.types.nullOr lib.types.int;
         default = null;
         description = ''
-          interface clock-frequency
+          The interface clock-frequency to configure.
         '';
       };
     };
     i2c1 = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "" // {
+        description = ''
           Turn on the ARM I2C bus (/dev/i2c-1 on GPIO pins 3 and 5) and enable access from the i2c group.
           After a reboot, i2c-tools (e.g. i2cdetect -F 1) should work for root or any user in i2c.
         '';
+      };
       frequency = lib.mkOption {
         type = lib.types.nullOr lib.types.int;
         default = null;
         description = ''
-          interface clock-frequency
+          The interface clock-frequency to configure.
         '';
       };
     };

raspberry-pi/4/pkgs-overlays.nix

@@ -10,12 +10,14 @@ in
 {
   options.hardware = {
     raspberry-pi."4".apply-overlays-dtmerge = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "" // {
-        replace deviceTree.applyOverlays implementation to use dtmerge from libraspberrypi.
+        description = ''
-        this can resolve issues with applying dtbs for the pi.
+          Whether replace deviceTree.applyOverlays implementation to use dtmerge from libraspberrypi.
+          This can resolve issues with applying dtbs for the pi.
         '';
       };
     };
+  };
 
   config = lib.mkIf cfg.enable {
     nixpkgs.overlays = [ dt_ao_overlay ];

raspberry-pi/4/poe-hat.nix

@@ -6,9 +6,7 @@ in
 {
   options.hardware = {
     raspberry-pi."4".poe-hat = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "support for the Raspberry Pi POE Hat";
-        support for the Raspberry Pi POE Hat.
-      '';
     };
   };
 

raspberry-pi/4/poe-plus-hat.nix

@@ -6,9 +6,7 @@ in
 {
   options.hardware = {
     raspberry-pi."4".poe-plus-hat = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "support for the Raspberry Pi PoE+ HAT";
-        support for the Raspberry Pi PoE+ HAT.
-      '';
     };
   };
 

raspberry-pi/4/pwm0.nix

@@ -6,9 +6,7 @@ in
 {
   options.hardware = {
     raspberry-pi."4".pwm0 = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "support for the hardware pwm0 channel on GPIO_18";
-        Enable support for the hardware pwm0 channel on GPIO_18
-      '';
     };
   };
 

raspberry-pi/4/tc358743.nix

@@ -6,13 +6,15 @@ in
 {
   options.hardware = {
     raspberry-pi."4".tc358743 = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "" // {
+        description = ''
           Enable support for the Toshiba TC358743 HDMI-to-CSI-2 converter.
 
           This can be tested with a plugged in converter device and for example
           running ustreamer (which starts webservice providing a camera stream):
           ''${pkgs.ustreamer}/bin/ustreamer --persistent --dv-timings
         '';
+      };
       lanes = lib.mkOption {
         type = lib.types.enum [
           2
@@ -23,13 +25,15 @@ in
           Number of CSI lanes available
         '';
       };
-      media-controller = lib.mkEnableOption ''
+      media-controller = lib.mkEnableOption "" // {
+        description = ''
           Enable support for the Media Controller API.
 
           See https://forums.raspberrypi.com/viewtopic.php?t=322076 for details
         '';
       };
     };
+  };
 
   config = lib.mkIf cfg.enable {
     hardware.deviceTree.filter = "bcm2711-rpi-4*.dtb";

raspberry-pi/4/touch-ft5406.nix

@@ -6,7 +6,8 @@ in
 {
   options.hardware = {
     raspberry-pi."4".touch-ft5406 = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "" // {
+        description = ''
           Enable the touch controller of the official Raspberry Pi touch diplay.
 
           The overlay is taken from the official Raspberry Pi Linux fork, and
@@ -18,6 +19,7 @@ in
         '';
       };
     };
+  };
 
   config = lib.mkIf cfg.enable {
     hardware.deviceTree = {

raspberry-pi/4/tv-hat.nix

@@ -6,9 +6,7 @@ in
 {
   options.hardware = {
     raspberry-pi."4".tv-hat = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "support for the Raspberry Pi TV Hat";
-        support for the Raspberry Pi TV Hat.
-      '';
     };
   };
   config = lib.mkIf cfg.enable {

raspberry-pi/4/xhci.nix

@@ -9,9 +9,7 @@ in
 {
   options.hardware = {
     raspberry-pi."4".xhci = {
-      enable = lib.mkEnableOption ''
+      enable = lib.mkEnableOption "builtin XHCI controller for USB with otg_mode=1 in config.txt";
-        Enable builtin XHCI controller for USB with otg_mode=1 in config.txt
-      '';
     };
   };