Clone of https://github.com/NixOS/nixpkgs.git (to stress-test knotserver)

Add missing 'type', 'defaultText' and 'literalExample' in module definitions

- add missing types in module definitions
- add missing 'defaultText' in module definitions
- wrap example with 'literalExample' where necessary in module definitions

+175 -97
+1
nixos/modules/config/ldap.nix
··· 57 57 users.ldap = { 58 58 59 59 enable = mkOption { 60 + type = types.bool; 60 61 default = false; 61 62 description = "Whether to enable authentication against an LDAP server."; 62 63 };
+1
nixos/modules/config/pulseaudio.nix
··· 99 99 package = mkOption { 100 100 type = types.package; 101 101 default = pulseaudioLight; 102 + defaultText = "pkgs.pulseaudioLight"; 102 103 example = literalExample "pkgs.pulseaudioFull"; 103 104 description = '' 104 105 The PulseAudio derivation to use. This can be used to enable
+1
nixos/modules/config/shells-environment.nix
··· 119 119 120 120 environment.binsh = mkOption { 121 121 default = "${config.system.build.binsh}/bin/sh"; 122 + defaultText = "\${config.system.build.binsh}/bin/sh"; 122 123 example = literalExample '' 123 124 "''${pkgs.dash}/bin/dash" 124 125 '';
+3 -2
nixos/modules/config/unix-odbc-drivers.nix
··· 10 10 11 11 options = { 12 12 environment.unixODBCDrivers = mkOption { 13 + type = types.listOf types.package; 13 14 default = []; 14 - example = literalExample "map (x : x.ini) (with pkgs.unixODBCDrivers; [ mysql psql psqlng ] )"; 15 + example = literalExample "with pkgs.unixODBCDrivers; [ mysql psql psqlng ]"; 15 16 description = '' 16 17 Specifies Unix ODBC drivers to be registered in 17 18 <filename>/etc/odbcinst.ini</filename>. You may also want to ··· 26 27 config = mkIf (config.environment.unixODBCDrivers != []) { 27 28 28 29 environment.etc."odbcinst.ini".text = 29 - let inis = config.environment.unixODBCDrivers; 30 + let inis = map (x : x.ini) config.environment.unixODBCDrivers; 30 31 in lib.concatStringsSep "\n" inis; 31 32 32 33 };
+1
nixos/modules/misc/crashdump.nix
··· 24 24 ''; 25 25 }; 26 26 kernelPackages = mkOption { 27 + type = types.package; 27 28 default = pkgs.linuxPackages; 28 29 # We don't want to evaluate all of linuxPackages for the manual 29 30 # - some of it might not even evaluate correctly.
+2 -2
nixos/modules/misc/nixos.nix
··· 37 37 38 38 nixos.extraModules = mkOption { 39 39 default = []; 40 - example = literalExample "mkIf config.services.openssh.enable [ ./sshd-config.nix ]"; 41 - type = types.listOf types.unspecified; 40 + example = literalExample "[ ./sshd-config.nix ]"; 41 + type = types.listOf (types.either (types.submodule ({...}:{options={};})) types.path); 42 42 description = '' 43 43 Define additional modules which would be loaded to evaluate the 44 44 configuration.
+14 -10
nixos/modules/programs/ssh.nix
··· 93 93 }; 94 94 95 95 package = mkOption { 96 + type = types.package; 96 97 default = pkgs.openssh; 98 + defaultText = "pkgs.openssh"; 97 99 description = '' 98 100 The package used for the openssh client and daemon. 99 101 ''; ··· 142 144 description = '' 143 145 The set of system-wide known SSH hosts. 144 146 ''; 145 - example = [ 146 - { 147 - hostNames = [ "myhost" "myhost.mydomain.com" "10.10.1.4" ]; 148 - publicKeyFile = literalExample "./pubkeys/myhost_ssh_host_dsa_key.pub"; 149 - } 150 - { 151 - hostNames = [ "myhost2" ]; 152 - publicKeyFile = literalExample "./pubkeys/myhost2_ssh_host_dsa_key.pub"; 153 - } 154 - ]; 147 + example = literalExample '' 148 + [ 149 + { 150 + hostNames = [ "myhost" "myhost.mydomain.com" "10.10.1.4" ]; 151 + publicKeyFile = "./pubkeys/myhost_ssh_host_dsa_key.pub"; 152 + } 153 + { 154 + hostNames = [ "myhost2" ]; 155 + publicKeyFile = "./pubkeys/myhost2_ssh_host_dsa_key.pub"; 156 + } 157 + ] 158 + ''; 155 159 }; 156 160 157 161 };
+1 -1
nixos/modules/services/audio/liquidsoap.nix
··· 46 46 example = { 47 47 myStream1 = literalExample "\"/etc/liquidsoap/myStream1.liq\""; 48 48 myStream2 = literalExample "./myStream2.liq"; 49 - myStream3 = literalExample "\"out(playlist(\"/srv/music/\"))\""; 49 + myStream3 = literalExample "\"out(playlist(\\\"/srv/music/\\\"))\""; 50 50 }; 51 51 52 52 type = types.attrsOf (types.either types.path types.str);
+2 -2
nixos/modules/services/backup/bacula.nix
··· 207 207 description = '' 208 208 Extra configuration to be passed in Client directive. 209 209 ''; 210 - example = literalExample '' 210 + example = '' 211 211 Maximum Concurrent Jobs = 20; 212 212 Heartbeat Interval = 30; 213 213 ''; ··· 218 218 description = '' 219 219 Extra configuration to be passed in Messages directive. 220 220 ''; 221 - example = literalExample '' 221 + example = '' 222 222 console = all 223 223 ''; 224 224 };
+1
nixos/modules/services/backup/rsnapshot.nix
··· 43 43 package = mkOption { 44 44 type = types.package; 45 45 default = pkgs.rsnapshot; 46 + defaultText = "pkgs.rsnapshot"; 46 47 example = literalExample "pkgs.rsnapshotGit"; 47 48 description = '' 48 49 RSnapshot package to use.
+1
nixos/modules/services/continuous-integration/jenkins/default.nix
··· 80 80 81 81 packages = mkOption { 82 82 default = [ pkgs.stdenv pkgs.git pkgs.jdk config.programs.ssh.package pkgs.nix ]; 83 + defaultText = "[ pkgs.stdenv pkgs.git pkgs.jdk config.programs.ssh.package pkgs.nix ]"; 83 84 type = types.listOf types.package; 84 85 description = '' 85 86 Packages to add to PATH for the jenkins process.
+1 -1
nixos/modules/services/continuous-integration/jenkins/job-builder.nix
··· 74 74 ]; 75 75 }; 76 76 } 77 - ]; 77 + ] 78 78 ''; 79 79 description = '' 80 80 Job descriptions for Jenkins Job Builder in Nix format.
+1
nixos/modules/services/databases/couchdb.nix
··· 38 38 package = mkOption { 39 39 type = types.package; 40 40 default = pkgs.couchdb; 41 + defaultText = "pkgs.couchdb"; 41 42 example = literalExample "pkgs.couchdb"; 42 43 description = '' 43 44 CouchDB package to use.
+1
nixos/modules/services/databases/firebird.nix
··· 49 49 50 50 package = mkOption { 51 51 default = pkgs.firebirdSuper; 52 + defaultText = "pkgs.firebirdSuper"; 52 53 type = types.package; 53 54 /* 54 55 Example: <code>package = pkgs.firebirdSuper.override { icu =
+1
nixos/modules/services/databases/hbase.nix
··· 44 44 package = mkOption { 45 45 type = types.package; 46 46 default = pkgs.hbase; 47 + defaultText = "pkgs.hbase"; 47 48 example = literalExample "pkgs.hbase"; 48 49 description = '' 49 50 HBase package to use.
+1
nixos/modules/services/databases/influxdb.nix
··· 120 120 121 121 package = mkOption { 122 122 default = pkgs.influxdb; 123 + defaultText = "pkgs.influxdb"; 123 124 description = "Which influxdb derivation to use"; 124 125 type = types.package; 125 126 };
+1
nixos/modules/services/databases/mongodb.nix
··· 41 41 42 42 package = mkOption { 43 43 default = pkgs.mongodb; 44 + defaultText = "pkgs.mongodb"; 44 45 type = types.package; 45 46 description = " 46 47 Which MongoDB derivation to use.
+1
nixos/modules/services/databases/neo4j.nix
··· 49 49 package = mkOption { 50 50 description = "Neo4j package to use."; 51 51 default = pkgs.neo4j; 52 + defaultText = "pkgs.neo4j"; 52 53 type = types.package; 53 54 }; 54 55
+14 -16
nixos/modules/services/databases/openldap.nix
··· 25 25 description = " 26 26 Whether to enable the ldap server. 27 27 "; 28 - example = literalExample '' 29 - openldap.enable = true; 30 - openldap.extraConfig = ''' 31 - include ''${pkgs.openldap}/etc/openldap/schema/core.schema 32 - include ''${pkgs.openldap}/etc/openldap/schema/cosine.schema 33 - include ''${pkgs.openldap}/etc/openldap/schema/inetorgperson.schema 34 - include ''${pkgs.openldap}/etc/openldap/schema/nis.schema 35 - 36 - database bdb 37 - suffix dc=example,dc=org 38 - rootdn cn=admin,dc=example,dc=org 39 - # NOTE: change after first start 40 - rootpw secret 41 - directory /var/db/openldap 42 - '''; 43 - ''; 28 + example = true; 44 29 }; 45 30 46 31 user = mkOption { ··· 67 52 description = " 68 53 sldapd.conf configuration 69 54 "; 55 + example = '' 56 + include ''${pkgs.openldap}/etc/openldap/schema/core.schema 57 + include ''${pkgs.openldap}/etc/openldap/schema/cosine.schema 58 + include ''${pkgs.openldap}/etc/openldap/schema/inetorgperson.schema 59 + include ''${pkgs.openldap}/etc/openldap/schema/nis.schema 60 + 61 + database bdb 62 + suffix dc=example,dc=org 63 + rootdn cn=admin,dc=example,dc=org 64 + # NOTE: change after first start 65 + rootpw secret 66 + directory /var/db/openldap 67 + ''; 70 68 }; 71 69 }; 72 70
+1
nixos/modules/services/databases/opentsdb.nix
··· 26 26 package = mkOption { 27 27 type = types.package; 28 28 default = pkgs.opentsdb; 29 + defaultText = "pkgs.opentsdb"; 29 30 example = literalExample "pkgs.opentsdb"; 30 31 description = '' 31 32 OpenTSDB package to use.
+1
nixos/modules/services/databases/redis.nix
··· 46 46 package = mkOption { 47 47 type = types.package; 48 48 default = pkgs.redis; 49 + defaultText = "pkgs.redis"; 49 50 description = "Which Redis derivation to use."; 50 51 }; 51 52
+1
nixos/modules/services/hardware/freefall.nix
··· 21 21 package = mkOption { 22 22 type = types.package; 23 23 default = pkgs.freefall; 24 + defaultText = "pkgs.freefall"; 24 25 description = '' 25 26 freefall derivation to use. 26 27 '';
+1
nixos/modules/services/hardware/upower.nix
··· 27 27 package = mkOption { 28 28 type = types.package; 29 29 default = pkgs.upower; 30 + defaultText = "pkgs.upower"; 30 31 example = lib.literalExample "pkgs.upower"; 31 32 description = '' 32 33 Which upower package to use.
+1
nixos/modules/services/logging/logrotate.nix
··· 13 13 options = { 14 14 services.logrotate = { 15 15 enable = mkOption { 16 + type = lib.types.bool; 16 17 default = false; 17 18 description = '' 18 19 Enable the logrotate cron job
+2 -1
nixos/modules/services/logging/logstash.nix
··· 33 33 package = mkOption { 34 34 type = types.package; 35 35 default = pkgs.logstash; 36 + defaultText = "pkgs.logstash"; 36 37 example = literalExample "pkgs.logstash"; 37 38 description = "Logstash package to use."; 38 39 }; ··· 84 85 type = types.lines; 85 86 default = ''stdin { type => "example" }''; 86 87 description = "Logstash input configuration."; 87 - example = literalExample '' 88 + example = '' 88 89 # Read from journal 89 90 pipe { 90 91 command => "''${pkgs.systemd}/bin/journalctl -f -o json"
+1
nixos/modules/services/logging/syslog-ng.nix
··· 39 39 package = mkOption { 40 40 type = types.package; 41 41 default = pkgs.syslogng; 42 + defaultText = "pkgs.syslogng"; 42 43 description = '' 43 44 The package providing syslog-ng binaries. 44 45 '';
+2 -1
nixos/modules/services/mail/dovecot.nix
··· 90 90 package = mkOption { 91 91 type = types.package; 92 92 default = pkgs.dovecot22; 93 + defaultText = "pkgs.dovecot22"; 93 94 description = "Dovecot package to use."; 94 95 }; 95 96 ··· 131 132 modules = mkOption { 132 133 type = types.listOf types.package; 133 134 default = []; 134 - example = [ pkgs.dovecot_pigeonhole ]; 135 + example = literalExample "[ pkgs.dovecot_pigeonhole ]"; 135 136 description = '' 136 137 Symlinks the contents of lib/dovecot of every given package into 137 138 /var/lib/dovecot/modules. This will make the given modules available
+1 -2
nixos/modules/services/misc/apache-kafka.nix
··· 118 118 119 119 package = mkOption { 120 120 description = "The kafka package to use"; 121 - 122 121 default = pkgs.apacheKafka; 123 - 122 + defaultText = "pkgs.apacheKafka"; 124 123 type = types.package; 125 124 }; 126 125
+2 -1
nixos/modules/services/misc/autofs.nix
··· 27 27 }; 28 28 29 29 autoMaster = mkOption { 30 + type = types.str; 30 31 example = literalExample '' 31 - autoMaster = let 32 + let 32 33 mapConf = pkgs.writeText "auto" ''' 33 34 kernel -ro,soft,intr ftp.kernel.org:/pub/linux 34 35 boot -fstype=ext2 :/dev/hda1
+1
nixos/modules/services/misc/cgminer.nix
··· 41 41 42 42 package = mkOption { 43 43 default = pkgs.cgminer; 44 + defaultText = "pkgs.cgminer"; 44 45 description = "Which cgminer derivation to use."; 45 46 type = types.package; 46 47 };
+1
nixos/modules/services/misc/confd.nix
··· 64 64 package = mkOption { 65 65 description = "Confd package to use."; 66 66 default = pkgs.confd; 67 + defaultText = "pkgs.confd"; 67 68 type = types.package; 68 69 }; 69 70 };
+5 -5
nixos/modules/services/misc/etcd.nix
··· 77 77 default = {}; 78 78 example = literalExample '' 79 79 { 80 - "CORS": "*", 81 - "NAME": "default-name", 82 - "MAX_RESULT_BUFFER": "1024", 83 - "MAX_CLUSTER_SIZE": "9", 84 - "MAX_RETRY_ATTEMPTS": "3" 80 + "CORS" = "*"; 81 + "NAME" = "default-name"; 82 + "MAX_RESULT_BUFFER" = "1024"; 83 + "MAX_CLUSTER_SIZE" = "9"; 84 + "MAX_RETRY_ATTEMPTS" = "3"; 85 85 } 86 86 ''; 87 87 };
+2
nixos/modules/services/misc/felix.nix
··· 23 23 }; 24 24 25 25 bundles = mkOption { 26 + type = types.listOf types.package; 26 27 default = [ pkgs.felix_remoteshell ]; 28 + defaultText = "[ pkgs.felix_remoteshell ]"; 27 29 description = "List of bundles that should be activated on startup"; 28 30 }; 29 31
+1
nixos/modules/services/misc/gitit.nix
··· 35 35 }; 36 36 37 37 haskellPackages = mkOption { 38 + type = types.attrsOf types.package; 38 39 default = pkgs.haskellPackages; 39 40 defaultText = "pkgs.haskellPackages"; 40 41 example = literalExample "pkgs.haskell.packages.ghc784";
+1
nixos/modules/services/misc/ihaskell.nix
··· 22 22 }; 23 23 24 24 haskellPackages = mkOption { 25 + type = types.attrsOf types.package; 25 26 default = pkgs.haskellPackages; 26 27 defaultText = "pkgs.haskellPackages"; 27 28 example = literalExample "pkgs.haskell.packages.ghc784";
+2
nixos/modules/services/misc/mbpfan.nix
··· 17 17 }; 18 18 19 19 package = mkOption { 20 + type = types.package; 20 21 default = pkgs.mbpfan; 22 + defaultText = "pkgs.mbpfan"; 21 23 description = '' 22 24 The package used for the mbpfan daemon. 23 25 '';
+1
nixos/modules/services/misc/nix-daemon.nix
··· 66 66 package = mkOption { 67 67 type = types.package; 68 68 default = pkgs.nix; 69 + defaultText = "pkgs.nix"; 69 70 description = '' 70 71 This option specifies the Nix package instance to use throughout the system. 71 72 '';
+4 -3
nixos/modules/services/misc/rippled.nix
··· 208 208 description = "Which rippled package to use."; 209 209 type = types.package; 210 210 default = pkgs.rippled; 211 + defaultText = "pkgs.rippled"; 211 212 }; 212 213 213 214 ports = mkOption { ··· 238 239 nodeDb = mkOption { 239 240 description = "Rippled main database options."; 240 241 type = types.nullOr types.optionSet; 241 - options = [dbOptions]; 242 + options = dbOptions; 242 243 default = { 243 244 type = "rocksdb"; 244 245 extraOpts = '' ··· 254 255 tempDb = mkOption { 255 256 description = "Rippled temporary database options."; 256 257 type = types.nullOr types.optionSet; 257 - options = [dbOptions]; 258 + options = dbOptions; 258 259 default = null; 259 260 }; 260 261 261 262 importDb = mkOption { 262 263 description = "Settings for performing a one-time import."; 263 264 type = types.nullOr types.optionSet; 264 - options = [dbOptions]; 265 + options = dbOptions; 265 266 default = null; 266 267 }; 267 268
+1
nixos/modules/services/monitoring/bosun.nix
··· 33 33 package = mkOption { 34 34 type = types.package; 35 35 default = pkgs.bosun; 36 + defaultText = "pkgs.bosun"; 36 37 example = literalExample "pkgs.bosun"; 37 38 description = '' 38 39 bosun binary to use.
+1
nixos/modules/services/monitoring/grafana.nix
··· 93 93 package = mkOption { 94 94 description = "Package to use."; 95 95 default = pkgs.grafana; 96 + defaultText = "pkgs.grafana"; 96 97 type = types.package; 97 98 }; 98 99
+4 -3
nixos/modules/services/monitoring/graphite.nix
··· 108 108 finders = mkOption { 109 109 description = "List of finder plugins to load."; 110 110 default = []; 111 - example = [ pkgs.python27Packages.graphite_influxdb ]; 111 + example = literalExample "[ pkgs.python27Packages.graphite_influxdb ]"; 112 112 type = types.listOf types.package; 113 113 }; 114 114 ··· 136 136 package = mkOption { 137 137 description = "Package to use for graphite api."; 138 138 default = pkgs.python27Packages.graphite_api; 139 + defaultText = "pkgs.python27Packages.graphite_api"; 139 140 type = types.package; 140 141 }; 141 142 ··· 146 147 directories: 147 148 - ${dataDir}/whisper 148 149 ''; 149 - example = literalExample '' 150 + example = '' 150 151 allowed_origins: 151 152 - dashboard.example.com 152 153 cheat_times: true ··· 350 351 critical: 200 351 352 name: Test 352 353 ''; 353 - example = literalExample '' 354 + example = '' 354 355 pushbullet_key: pushbullet_api_key 355 356 alerts: 356 357 - target: stats.seatgeek.app.deal_quality.venue_info_cache.hit
+1
nixos/modules/services/monitoring/heapster.nix
··· 33 33 package = mkOption { 34 34 description = "Package to use by heapster"; 35 35 default = pkgs.heapster; 36 + defaultText = "pkgs.heapster"; 36 37 type = types.package; 37 38 }; 38 39 };
+3 -15
nixos/modules/services/monitoring/munin.nix
··· 122 122 HTML output is in <filename>/var/www/munin/</filename>, configure your 123 123 favourite webserver to serve static files. 124 124 ''; 125 - example = literalExample '' 126 - services = { 127 - munin-node.enable = true; 128 - munin-cron = { 129 - enable = true; 130 - hosts = ''' 131 - [''${config.networking.hostName}] 132 - address localhost 133 - '''; 134 - extraGlobalConfig = ''' 135 - contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com 136 - '''; 137 - }; 138 - }; 139 - ''; 140 125 }; 141 126 142 127 extraGlobalConfig = mkOption { ··· 146 131 See <link xlink:href='http://munin-monitoring.org/wiki/munin.conf' />. 147 132 Useful to setup notifications, see 148 133 <link xlink:href='http://munin-monitoring.org/wiki/HowToContact' /> 134 + ''; 135 + example = '' 136 + contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com 149 137 ''; 150 138 }; 151 139
+6
nixos/modules/services/monitoring/nagios.nix
··· 94 94 }; 95 95 96 96 plugins = mkOption { 97 + type = types.listOf types.package; 97 98 default = [pkgs.nagiosPluginsOfficial pkgs.ssmtp]; 99 + defaultText = "[pkgs.nagiosPluginsOfficial pkgs.ssmtp]"; 98 100 description = " 99 101 Packages to be added to the Nagios <envar>PATH</envar>. 100 102 Typically used to add plugins, but can be anything. ··· 102 104 }; 103 105 104 106 mainConfigFile = mkOption { 107 + type = types.package; 105 108 default = nagiosCfgFile; 109 + defaultText = "nagiosCfgFile"; 106 110 description = " 107 111 Derivation for the main configuration file of Nagios. 108 112 "; 109 113 }; 110 114 111 115 cgiConfigFile = mkOption { 116 + type = types.package; 112 117 default = nagiosCGICfgFile; 118 + defaultText = "nagiosCGICfgFile"; 113 119 description = " 114 120 Derivation for the configuration file of Nagios CGI scripts 115 121 that can be used in web servers for running the Nagios web interface.
+2 -1
nixos/modules/services/monitoring/scollector.nix
··· 43 43 package = mkOption { 44 44 type = types.package; 45 45 default = pkgs.scollector; 46 + defaultText = "pkgs.scollector"; 46 47 example = literalExample "pkgs.scollector"; 47 48 description = '' 48 49 scollector binary to use. ··· 77 78 collectors = mkOption { 78 79 type = with types; attrsOf (listOf path); 79 80 default = {}; 80 - example = literalExample "{ 0 = [ \"\${postgresStats}/bin/collect-stats\" ]; }"; 81 + example = literalExample "{ \"0\" = [ \"\${postgresStats}/bin/collect-stats\" ]; }"; 81 82 description = '' 82 83 An attribute set mapping the frequency of collection to a list of 83 84 binaries that should be executed at that frequency. You can use "0"
+2 -1
nixos/modules/services/network-filesystems/samba.nix
··· 85 85 package = mkOption { 86 86 type = types.package; 87 87 default = pkgs.samba; 88 - example = pkgs.samba4; 88 + defaultText = "pkgs.samba"; 89 + example = literalExample "pkgs.samba4"; 89 90 description = '' 90 91 Defines which package should be used for the samba server. 91 92 '';
+2
nixos/modules/services/networking/bind.nix
··· 120 120 }; 121 121 122 122 configFile = mkOption { 123 + type = types.path; 123 124 default = confFile; 125 + defaultText = "confFile"; 124 126 description = " 125 127 Overridable config file to use for named. By default, that 126 128 generated by nixos.
+1
nixos/modules/services/networking/consul.nix
··· 118 118 package = mkOption { 119 119 description = "Package to use for consul-alerts."; 120 120 default = pkgs.consul-alerts; 121 + defaultText = "pkgs.consul-alerts"; 121 122 type = types.package; 122 123 }; 123 124
+2 -1
nixos/modules/services/networking/firewall.nix
··· 421 421 }; 422 422 423 423 networking.firewall.extraPackages = mkOption { 424 + type = types.listOf types.package; 424 425 default = [ ]; 425 - example = [ pkgs.ipset ]; 426 + example = literalExample "[ pkgs.ipset ]"; 426 427 description = 427 428 '' 428 429 Additional packages to be included in the environment of the system
+1
nixos/modules/services/networking/lambdabot.nix
··· 27 27 package = mkOption { 28 28 type = types.package; 29 29 default = pkgs.lambdabot; 30 + defaultText = "pkgs.lambdabot"; 30 31 description = "Used lambdabot package"; 31 32 }; 32 33
+1 -1
nixos/modules/services/networking/networkmanager.nix
··· 110 110 111 111 # Ugly hack for using the correct gnome3 packageSet 112 112 basePackages = mkOption { 113 - type = types.attrsOf types.path; 113 + type = types.attrsOf types.package; 114 114 default = { inherit networkmanager modemmanager wpa_supplicant 115 115 networkmanager_openvpn networkmanager_vpnc 116 116 networkmanager_openconnect
+1
nixos/modules/services/networking/ngircd.nix
··· 34 34 type = types.package; 35 35 36 36 default = pkgs.ngircd; 37 + defaultText = "pkgs.ngircd"; 37 38 }; 38 39 }; 39 40 };
+1
nixos/modules/services/networking/skydns.nix
··· 56 56 57 57 package = mkOption { 58 58 default = pkgs.skydns; 59 + defaultText = "pkgs.skydns"; 59 60 type = types.package; 60 61 description = "Skydns package to use."; 61 62 };
+1 -1
nixos/modules/services/networking/supplicant.nix
··· 115 115 116 116 path = mkOption { 117 117 type = types.path; 118 - example = "/etc/wpa_supplicant.conf"; 118 + example = literalExample "/etc/wpa_supplicant.conf"; 119 119 description = '' 120 120 External <literal>wpa_supplicant.conf</literal> configuration file. 121 121 The configuration options defined declaratively within <literal>networking.supplicant</literal> have
+1
nixos/modules/services/networking/syncthing.nix
··· 43 43 package = mkOption { 44 44 type = types.package; 45 45 default = pkgs.syncthing; 46 + defaultText = "pkgs.syncthing"; 46 47 example = literalExample "pkgs.syncthing"; 47 48 description = '' 48 49 Syncthing package to use.
+2
nixos/modules/services/networking/tinc.nix
··· 87 87 }; 88 88 89 89 package = mkOption { 90 + type = types.package; 90 91 default = pkgs.tinc_pre; 92 + defaultText = "pkgs.tinc_pre"; 91 93 description = '' 92 94 The package to use for the tinc daemon's binary. 93 95 '';
+2
nixos/modules/services/networking/vsftpd.nix
··· 120 120 }; 121 121 122 122 userlistFile = mkOption { 123 + type = types.path; 123 124 default = pkgs.writeText "userlist" (concatMapStrings (x: "${x}\n") cfg.userlist); 125 + defaultText = "pkgs.writeText \"userlist\" (concatMapStrings (x: \"\${x}\n\") cfg.userlist)"; 124 126 description = '' 125 127 Newline separated list of names to be allowed/denied if <option>userlistEnable</option> 126 128 is <literal>true</literal>. Meaning see <option>userlistDeny</option>.
+1
nixos/modules/services/search/elasticsearch.nix
··· 40 40 package = mkOption { 41 41 description = "Elasticsearch package to use."; 42 42 default = pkgs.elasticsearch; 43 + defaultText = "pkgs.elasticsearch"; 43 44 type = types.package; 44 45 }; 45 46
+1
nixos/modules/services/search/kibana.nix
··· 127 127 package = mkOption { 128 128 description = "Kibana package to use"; 129 129 default = pkgs.kibana; 130 + defaultText = "pkgs.kibana"; 130 131 type = types.package; 131 132 }; 132 133
+2
nixos/modules/services/search/solr.nix
··· 45 45 javaPackage = mkOption { 46 46 type = types.package; 47 47 default = pkgs.jre; 48 + defaultText = "pkgs.jre"; 48 49 description = '' 49 50 Which Java derivation to use for running solr. 50 51 ''; ··· 53 54 solrPackage = mkOption { 54 55 type = types.package; 55 56 default = pkgs.solr; 57 + defaultText = "pkgs.solr"; 56 58 description = '' 57 59 Which solr derivation to use for running solr. 58 60 '';
+3 -1
nixos/modules/services/web-servers/apache-httpd/default.nix
··· 429 429 package = mkOption { 430 430 type = types.package; 431 431 default = pkgs.apacheHttpd; 432 + defaultText = "pkgs.apacheHttpd"; 432 433 description = '' 433 434 Overridable attribute of the Apache HTTP Server package to use. 434 435 ''; ··· 437 438 configFile = mkOption { 438 439 type = types.path; 439 440 default = confFile; 440 - example = literalExample ''pkgs.writeText "httpd.conf" "# my custom config file ...";''; 441 + defaultText = "confFile"; 442 + example = literalExample ''pkgs.writeText "httpd.conf" "# my custom config file ..."''; 441 443 description = '' 442 444 Override the configuration file used by Apache. By default, 443 445 NixOS generates one automatically.
+1
nixos/modules/services/web-servers/nginx/default.nix
··· 34 34 35 35 package = mkOption { 36 36 default = pkgs.nginx; 37 + defaultText = "pkgs.nginx"; 37 38 type = types.package; 38 39 description = " 39 40 Nginx package to use.
+2
nixos/modules/services/web-servers/phpfpm.nix
··· 36 36 }; 37 37 38 38 phpPackage = mkOption { 39 + type = types.package; 39 40 default = pkgs.php; 41 + defaultText = "pkgs.php"; 40 42 description = '' 41 43 The PHP package to use for running the FPM service. 42 44 '';
+5
nixos/modules/services/web-servers/tomcat.nix
··· 24 24 package = mkOption { 25 25 type = types.package; 26 26 default = pkgs.tomcat7; 27 + defaultText = "pkgs.tomcat7"; 27 28 example = lib.literalExample "pkgs.tomcat8"; 28 29 description = '' 29 30 Which tomcat package to use. ··· 72 73 }; 73 74 74 75 webapps = mkOption { 76 + type = types.listOf types.package; 75 77 default = [ tomcat ]; 78 + defaultText = "[ tomcat ]"; 76 79 description = "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat"; 77 80 }; 78 81 ··· 87 90 }; 88 91 89 92 jdk = mkOption { 93 + type = types.package; 90 94 default = pkgs.jdk; 95 + defaultText = "pkgs.jdk"; 91 96 description = "Which JDK to use."; 92 97 }; 93 98
+1
nixos/modules/services/web-servers/winstone.nix
··· 31 31 javaPackage = mkOption { 32 32 type = types.package; 33 33 default = pkgs.jre; 34 + defaultText = "pkgs.jre"; 34 35 description = '' 35 36 Which Java derivation to use for running Winstone. 36 37 '';
+20 -19
nixos/modules/services/web-servers/zope2.nix
··· 75 75 services.zope2.instances = mkOption { 76 76 default = {}; 77 77 type = types.loaOf types.optionSet; 78 - example = { 79 - plone01 = { 80 - http_address = "127.0.0.1:8080"; 81 - extra = 82 - '' 83 - <zodb_db main> 84 - mount-point / 85 - cache-size 30000 86 - <blobstorage> 87 - blob-dir /var/lib/zope2/plone01/blobstorage 88 - <filestorage> 89 - path /var/lib/zope2/plone01/filestorage/Data.fs 90 - </filestorage> 91 - </blobstorage> 92 - </zodb_db> 93 - ''; 94 - 95 - }; 96 - }; 78 + example = literalExample '' 79 + { 80 + plone01 = { 81 + http_address = "127.0.0.1:8080"; 82 + extra = 83 + ''' 84 + <zodb_db main> 85 + mount-point / 86 + cache-size 30000 87 + <blobstorage> 88 + blob-dir /var/lib/zope2/plone01/blobstorage 89 + <filestorage> 90 + path /var/lib/zope2/plone01/filestorage/Data.fs 91 + </filestorage> 92 + </blobstorage> 93 + </zodb_db> 94 + '''; 95 + }; 96 + } 97 + ''; 97 98 description = "zope2 instances to be created automaticaly by the system."; 98 99 options = [ zope2Opts ]; 99 100 };
+1
nixos/modules/services/x11/desktop-managers/gnome3.nix
··· 62 62 }; 63 63 64 64 environment.gnome3.packageSet = mkOption { 65 + type = types.nullOr types.package; 65 66 default = null; 66 67 example = literalExample "pkgs.gnome3_16"; 67 68 description = "Which GNOME 3 package set to use.";
+1
nixos/modules/services/x11/desktop-managers/kde4.nix
··· 66 66 kdeWorkspacePackage = mkOption { 67 67 internal = true; 68 68 default = pkgs.kde4.kde_workspace; 69 + defaultText = "pkgs.kde4.kde_workspace"; 69 70 type = types.package; 70 71 description = "Custom kde-workspace, used for NixOS rebranding."; 71 72 };
+4 -2
nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix
··· 67 67 theme = { 68 68 69 69 package = mkOption { 70 - type = types.path; 70 + type = types.package; 71 71 default = pkgs.gnome3.gnome_themes_standard; 72 + defaultText = "pkgs.gnome3.gnome_themes_standard"; 72 73 description = '' 73 74 The package path that contains the theme given in the name option. 74 75 ''; ··· 87 88 iconTheme = { 88 89 89 90 package = mkOption { 90 - type = types.path; 91 + type = types.package; 91 92 default = pkgs.gnome3.defaultIconTheme; 93 + defaultText = "pkgs.gnome3.defaultIconTheme"; 92 94 description = '' 93 95 The package path that contains the icon theme given in the name option. 94 96 '';
+2 -1
nixos/modules/services/x11/display-managers/lightdm.nix
··· 69 69 70 70 greeter = { 71 71 package = mkOption { 72 - type = types.path; 72 + type = types.package; 73 73 description = '' 74 74 The LightDM greeter to login via. The package should be a directory 75 75 containing a .desktop file matching the name in the 'name' option. ··· 86 86 }; 87 87 88 88 background = mkOption { 89 + type = types.path; 89 90 description = '' 90 91 The background image or color to use. 91 92 '';
+4
nixos/modules/services/x11/display-managers/slim.nix
··· 61 61 url = "https://github.com/jagajaga/nixos-slim-theme/archive/2.0.tar.gz"; 62 62 sha256 = "0lldizhigx7bjhxkipii87y432hlf5wdvamnfxrryf9z7zkfypc8"; 63 63 }; 64 + defaultText = ''pkgs.fetchurl { 65 + url = "https://github.com/jagajaga/nixos-slim-theme/archive/2.0.tar.gz"; 66 + sha256 = "0lldizhigx7bjhxkipii87y432hlf5wdvamnfxrryf9z7zkfypc8"; 67 + }''; 64 68 example = literalExample '' 65 69 pkgs.fetchurl { 66 70 url = "mirror://sourceforge/slim.berlios/slim-wave.tar.gz";
+1
nixos/modules/services/x11/redshift.nix
··· 76 76 package = mkOption { 77 77 type = types.package; 78 78 default = pkgs.redshift; 79 + defaultText = "pkgs.redshift"; 79 80 description = '' 80 81 redshift derivation to use. 81 82 '';
+1
nixos/modules/services/x11/window-managers/xmonad.nix
··· 16 16 services.xserver.windowManager.xmonad = { 17 17 enable = mkEnableOption "xmonad"; 18 18 haskellPackages = mkOption { 19 + type = lib.types.packageSet; 19 20 default = pkgs.haskellPackages; 20 21 defaultText = "pkgs.haskellPackages"; 21 22 example = literalExample "pkgs.haskell.packages.ghc784";
+1 -1
nixos/modules/system/activation/top-level.nix
··· 205 205 206 206 system.replaceRuntimeDependencies = mkOption { 207 207 default = []; 208 - example = lib.literalExample "[ ({ original = pkgs.openssl; replacement = pkgs.callPackage /path/to/openssl { ... }; }) ]"; 208 + example = lib.literalExample "[ ({ original = pkgs.openssl; replacement = pkgs.callPackage /path/to/openssl { }; }) ]"; 209 209 type = types.listOf (types.submodule ( 210 210 { options, ... }: { 211 211 options.original = mkOption {
+2 -1
nixos/modules/system/boot/kernel.nix
··· 20 20 options = { 21 21 22 22 boot.kernelPackages = mkOption { 23 + type = types.packageSet; 23 24 default = pkgs.linuxPackages; 24 25 # We don't want to evaluate all of linuxPackages for the manual 25 26 # - some of it might not even evaluate correctly. ··· 63 64 }; 64 65 65 66 boot.extraModulePackages = mkOption { 66 - type = types.listOf types.path; 67 + type = types.listOf types.package; 67 68 default = []; 68 69 example = literalExample "[ pkgs.linuxPackages.nvidia_x11 ]"; 69 70 description = "A list of additional packages supplying kernel modules.";
+1
nixos/modules/system/boot/loader/grub/grub.nix
··· 251 251 }; 252 252 253 253 extraFiles = mkOption { 254 + type = types.attrsOf types.path; 254 255 default = {}; 255 256 example = literalExample '' 256 257 { "memtest.bin" = "''${pkgs.memtest86plus}/memtest.bin"; }
+1 -1
nixos/modules/system/boot/loader/grub/ipxe.nix
··· 39 39 dhcp 40 40 chain http://boot.ipxe.org/demo/boot.php 41 41 '''; 42 - }; 42 + } 43 43 ''; 44 44 }; 45 45 };
+1 -1
nixos/modules/system/boot/luksroot.nix
··· 229 229 230 230 boot.initrd.luks.devices = mkOption { 231 231 default = [ ]; 232 - example = [ { name = "luksroot"; device = "/dev/sda3"; preLVM = true; } ]; 232 + example = literalExample ''[ { name = "luksroot"; device = "/dev/sda3"; preLVM = true; } ]''; 233 233 description = '' 234 234 The list of devices that should be decrypted using LUKS before trying to mount the 235 235 root partition. This works for both LVM-over-LUKS and LUKS-over-LVM setups.
+1
nixos/modules/system/boot/systemd.nix
··· 374 374 375 375 systemd.package = mkOption { 376 376 default = pkgs.systemd; 377 + defaultText = "pkgs.systemd"; 377 378 type = types.package; 378 379 description = "The systemd package."; 379 380 };
+2
nixos/modules/tasks/network-interfaces.nix
··· 355 355 }; 356 356 357 357 networking.nameservers = mkOption { 358 + type = types.listOf types.str; 358 359 default = []; 359 360 example = ["130.161.158.4" "130.161.33.17"]; 360 361 description = '' ··· 390 391 }; 391 392 392 393 networking.localCommands = mkOption { 394 + type = types.str; 393 395 default = ""; 394 396 example = "text=anything; echo You can put $text here."; 395 397 description = ''
+1
nixos/modules/virtualisation/openvswitch.nix
··· 31 31 package = mkOption { 32 32 type = types.package; 33 33 default = pkgs.openvswitch; 34 + defaultText = "pkgs.openvswitch"; 34 35 description = '' 35 36 Open vSwitch package to use. 36 37 '';