Merge pull request #8630 from lihop/nixos/fix-formatting

nixos: fix formatting of option examples

nixos/modules/config/vpnc.nix

@@ -17,16 +17,16 @@ in
       services = mkOption {
        type = types.attrsOf types.str;
        default = {};
-       example = {
+       example = literalExample ''
-         test = 
+         { test = '''
-          ''
              IPSec gateway 192.168.1.1
              IPSec ID someID
              IPSec secret secretKey
              Xauth username name
              Xauth password pass
+           ''';
+         }
        '';
-       };
        description = 
          ''
            The names of cisco VPNs and their associated definitions

nixos/modules/programs/freetds.nix

@@ -17,14 +17,14 @@ in
     environment.freetds = mkOption {
       type = types.attrsOf types.str;
       default = {};
-      example = {
+      example = literalExample ''
-        MYDATABASE = 
+        { MYDATABASE = '''
-          ''
             host = 10.0.2.100
             port = 1433
             tds version = 7.2
+          ''';
+        }
       '';
-      };
       description = 
         ''
         Configure freetds database entries. Each attribute denotes

nixos/modules/security/ca.nix

@@ -35,7 +35,8 @@ in
     security.pki.certificates = mkOption {
       type = types.listOf types.str;
       default = [];
-      example = singleton ''
+      example = literalExample ''
+        [ '''
             NixOS.org
             =========
             -----BEGIN CERTIFICATE-----
@@ -43,6 +44,8 @@ in
             TDEWMBQGA1UEChMNU3RhcnRDb20gTHRkLjErMCkGA1UECxMiU2VjdXJlIERpZ2l0
             ...
             -----END CERTIFICATE-----
+          '''
+        ]
       '';
       description = ''
         A list of trusted root certificates in PEM format.

nixos/modules/services/networking/nsd.nix

@@ -621,34 +621,37 @@ in
       zones = mkOption {
         type        = types.attrsOf zoneOptions;
         default     = {};
-        example     = {
+        example     = literalExample ''
-          "serverGroup1" = {
+          { "serverGroup1" = {
               provideXFR = [ "10.1.2.3 NOKEY" ];
               children = {
                 "example.com." = {
-                data = ''
+                  data = '''
                     $ORIGIN example.com.
                     $TTL    86400
                     @ IN SOA a.ns.example.com. admin.example.com. (
                     ...
-                '';
+                  ''';
                 };
                 "example.org." = {
-                data = ''
+                  data = '''
                     $ORIGIN example.org.
                     $TTL    86400
                     @ IN SOA a.ns.example.com. admin.example.com. (
                     ...
-                '';
+                  ''';
                 };
               };
             };
 
             "example.net." = {
               provideXFR = [ "10.3.2.1 NOKEY" ];
-            data = ''...'';
+              data = '''
-          };
+                ...
+              ''';
             };
+          }
+        '';
         description = ''
           Define your zones here. Zones can cascade other zones and therefore
           inherit settings from parent zones. Look at the definition of

nixos/modules/services/security/fail2ban.nix

@@ -50,9 +50,8 @@ in
 
       jails = mkOption {
         default = { };
-        example =
+        example = literalExample ''
-          { "apache-nohome-iptables" =
+          { apache-nohome-iptables = '''
-              ''
               # Block an IP address if it accesses a non-existent
               # home directory more than 5 times in 10 minutes,
               # since that indicates that it's scanning.
@@ -62,8 +61,9 @@ in
               findtime = 600
               bantime  = 600
               maxretry = 5
+            ''';
+          }
         '';
-          };
         type = types.attrsOf types.lines;
         description =
           ''

nixos/modules/services/web-servers/phpfpm.nix

@@ -53,8 +53,8 @@ in {
       poolConfigs = mkOption {
         type = types.attrsOf types.lines;
         default = {};
-        example = {
+        example = literalExample ''
-          mypool = ''
+          { mypool = '''
               listen = /run/phpfpm/mypool
               user = nobody
               pm = dynamic
@@ -63,8 +63,9 @@ in {
               pm.min_spare_servers = 5
               pm.max_spare_servers = 20
               pm.max_requests = 500
+            ''';
+          }
         '';
-        };
         description = ''
           A mapping between PHP FPM pool names and their configurations.
           See the documentation on <literal>php-fpm.conf</literal> for

nixos/modules/services/x11/xserver.nix

@@ -156,13 +156,16 @@ in
       inputClassSections = mkOption {
         type = types.listOf types.lines;
         default = [];
-        example = [ ''
+        example = literalExample ''
+          [ '''
               Identifier      "Trackpoint Wheel Emulation"
               MatchProduct    "ThinkPad USB Keyboard with TrackPoint"
               Option          "EmulateWheel"          "true
               Option          "EmulateWheelButton"    "2"
               Option          "Emulate3Buttons"       "false"
-          '' ];
+            '''
+          ]
+        '';
         description = "Content of additional InputClass sections of the X server configuration file.";
       };
 

nixos/modules/system/activation/activation-script.nix

@@ -30,18 +30,19 @@ in
     system.activationScripts = mkOption {
       default = {};
 
-      example = {
+      example = literalExample ''
-        stdio = {
+        { stdio = {
-          text = ''
+            text = '''
               # Needed by some programs.
               ln -sfn /proc/self/fd /dev/fd
               ln -sfn /proc/self/fd/0 /dev/stdin
               ln -sfn /proc/self/fd/1 /dev/stdout
               ln -sfn /proc/self/fd/2 /dev/stderr
-          '';
+            ''';
             deps = [];
           };
-      };
+        }
+      '';
 
       description = ''
         A set of shell script fragments that are executed when a NixOS