ilyakooo0/nixpkgs
1
0
Fork 0
mirror of https://github.com/ilyakooo0/nixpkgs.git synced 2024-11-10 08:39:08 +03:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
- add missing types in module definitions
- add missing 'defaultText' in module definitions
- wrap example with 'literalExample' where necessary in module definitions
This commit is contained in:
Thomas Strobel 2016-01-17 19:34:55 +01:00
parent ae5ef2b009
commit a04a7272aa
81 changed files with 175 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
nixos/modules/config/ldap.nix
View File

@ -57,6 +57,7 @@ in
users.ldap = {
enable = mkOption {
type = types.bool;
default = false;
description = "Whether to enable authentication against an LDAP server.";
};

1
nixos/modules/config/pulseaudio.nix
View File

@ -99,6 +99,7 @@ in {
package = mkOption {
type = types.package;
default = pulseaudioLight;
defaultText = "pkgs.pulseaudioLight";
example = literalExample "pkgs.pulseaudioFull";
description = ''
The PulseAudio derivation to use. This can be used to enable

1
nixos/modules/config/shells-environment.nix
View File

@ -119,6 +119,7 @@ in
environment.binsh = mkOption {
default = "${config.system.build.binsh}/bin/sh";
defaultText = "\${config.system.build.binsh}/bin/sh";
example = literalExample ''
"''${pkgs.dash}/bin/dash"
'';

5
nixos/modules/config/unix-odbc-drivers.nix
View File

@ -10,8 +10,9 @@ with lib;
options = {
environment.unixODBCDrivers = mkOption {
type = types.listOf types.package;
default = [];
example = literalExample "map (x : x.ini) (with pkgs.unixODBCDrivers; [ mysql psql psqlng ] )";
example = literalExample "with pkgs.unixODBCDrivers; [ mysql psql psqlng ]";
description = ''
Specifies Unix ODBC drivers to be registered in
<filename>/etc/odbcinst.ini</filename>. You may also want to
@ -26,7 +27,7 @@ with lib;
config = mkIf (config.environment.unixODBCDrivers != []) {
environment.etc."odbcinst.ini".text =
let inis = config.environment.unixODBCDrivers;
let inis = map (x : x.ini) config.environment.unixODBCDrivers;
in lib.concatStringsSep "\n" inis;
};

1
nixos/modules/misc/crashdump.nix
View File

@ -24,6 +24,7 @@ in
'';
};
kernelPackages = mkOption {
type = types.package;
default = pkgs.linuxPackages;
# We don't want to evaluate all of linuxPackages for the manual
# - some of it might not even evaluate correctly.

4
nixos/modules/misc/nixos.nix
View File

@ -37,8 +37,8 @@ with lib;
nixos.extraModules = mkOption {
default = [];
example = literalExample "mkIf config.services.openssh.enable [ ./sshd-config.nix ]";
type = types.listOf types.unspecified;
example = literalExample "[ ./sshd-config.nix ]";
type = types.listOf (types.either (types.submodule ({...}:{options={};})) types.path);
description = ''
Define additional modules which would be loaded to evaluate the
configuration.

24
nixos/modules/programs/ssh.nix
View File

@ -93,7 +93,9 @@ in
};
package = mkOption {
type = types.package;
default = pkgs.openssh;
defaultText = "pkgs.openssh";
description = ''
The package used for the openssh client and daemon.
'';
@ -142,16 +144,18 @@ in
description = ''
The set of system-wide known SSH hosts.
'';
example = [
{
hostNames = [ "myhost" "myhost.mydomain.com" "10.10.1.4" ];
publicKeyFile = literalExample "./pubkeys/myhost_ssh_host_dsa_key.pub";
}
{
hostNames = [ "myhost2" ];
publicKeyFile = literalExample "./pubkeys/myhost2_ssh_host_dsa_key.pub";
}
];
example = literalExample ''
[
{
hostNames = [ "myhost" "myhost.mydomain.com" "10.10.1.4" ];
publicKeyFile = "./pubkeys/myhost_ssh_host_dsa_key.pub";
}
{
hostNames = [ "myhost2" ];
publicKeyFile = "./pubkeys/myhost2_ssh_host_dsa_key.pub";
}
]
'';
};
};

2
nixos/modules/services/audio/liquidsoap.nix
View File

@ -46,7 +46,7 @@ in
example = {
myStream1 = literalExample "\"/etc/liquidsoap/myStream1.liq\"";
myStream2 = literalExample "./myStream2.liq";
myStream3 = literalExample "\"out(playlist(\"/srv/music/\"))\"";
myStream3 = literalExample "\"out(playlist(\\\"/srv/music/\\\"))\"";
};
type = types.attrsOf (types.either types.path types.str);

4
nixos/modules/services/backup/bacula.nix
View File

@ -207,7 +207,7 @@ in {
description = ''
Extra configuration to be passed in Client directive.
'';
example = literalExample ''
example = ''
Maximum Concurrent Jobs = 20;
Heartbeat Interval = 30;
'';
@ -218,7 +218,7 @@ in {
description = ''
Extra configuration to be passed in Messages directive.
'';
example = literalExample ''
example = ''
console = all
'';
};

1
nixos/modules/services/backup/rsnapshot.nix
View File

@ -43,6 +43,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.rsnapshot;
defaultText = "pkgs.rsnapshot";
example = literalExample "pkgs.rsnapshotGit";
description = ''
RSnapshot package to use.

1
nixos/modules/services/continuous-integration/jenkins/default.nix
View File

@ -80,6 +80,7 @@ in {
packages = mkOption {
default = [ pkgs.stdenv pkgs.git pkgs.jdk config.programs.ssh.package pkgs.nix ];
defaultText = "[ pkgs.stdenv pkgs.git pkgs.jdk config.programs.ssh.package pkgs.nix ]";
type = types.listOf types.package;
description = ''
Packages to add to PATH for the jenkins process.

2
nixos/modules/services/continuous-integration/jenkins/job-builder.nix
View File

@ -74,7 +74,7 @@ in {
];
};
}
];
]
'';
description = ''
Job descriptions for Jenkins Job Builder in Nix format.

1
nixos/modules/services/databases/couchdb.nix
View File

@ -38,6 +38,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.couchdb;
defaultText = "pkgs.couchdb";
example = literalExample "pkgs.couchdb";
description = ''
CouchDB package to use.

1
nixos/modules/services/databases/firebird.nix
View File

@ -49,6 +49,7 @@ in
package = mkOption {
default = pkgs.firebirdSuper;
defaultText = "pkgs.firebirdSuper";
type = types.package;
/*
Example: <code>package = pkgs.firebirdSuper.override { icu =

1
nixos/modules/services/databases/hbase.nix
View File

@ -44,6 +44,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.hbase;
defaultText = "pkgs.hbase";
example = literalExample "pkgs.hbase";
description = ''
HBase package to use.

1
nixos/modules/services/databases/influxdb.nix
View File

@ -120,6 +120,7 @@ in
package = mkOption {
default = pkgs.influxdb;
defaultText = "pkgs.influxdb";
description = "Which influxdb derivation to use";
type = types.package;
};

1
nixos/modules/services/databases/mongodb.nix
View File

@ -41,6 +41,7 @@ in
package = mkOption {
default = pkgs.mongodb;
defaultText = "pkgs.mongodb";
type = types.package;
description = "
Which MongoDB derivation to use.

1
nixos/modules/services/databases/neo4j.nix
View File

@ -49,6 +49,7 @@ in {
package = mkOption {
description = "Neo4j package to use.";
default = pkgs.neo4j;
defaultText = "pkgs.neo4j";
type = types.package;
};

30
nixos/modules/services/databases/openldap.nix
View File

@ -25,22 +25,7 @@ in
description = "
Whether to enable the ldap server.
";
example = literalExample ''
openldap.enable = true;
openldap.extraConfig = '''
include ''${pkgs.openldap}/etc/openldap/schema/core.schema
include ''${pkgs.openldap}/etc/openldap/schema/cosine.schema
include ''${pkgs.openldap}/etc/openldap/schema/inetorgperson.schema
include ''${pkgs.openldap}/etc/openldap/schema/nis.schema
database bdb
suffix dc=example,dc=org
rootdn cn=admin,dc=example,dc=org
# NOTE: change after first start
rootpw secret
directory /var/db/openldap
''';
'';
example = true;
};
user = mkOption {
@ -67,6 +52,19 @@ in
description = "
sldapd.conf configuration
";
example = ''
include ''${pkgs.openldap}/etc/openldap/schema/core.schema
include ''${pkgs.openldap}/etc/openldap/schema/cosine.schema
include ''${pkgs.openldap}/etc/openldap/schema/inetorgperson.schema
include ''${pkgs.openldap}/etc/openldap/schema/nis.schema
database bdb
suffix dc=example,dc=org
rootdn cn=admin,dc=example,dc=org
# NOTE: change after first start
rootpw secret
directory /var/db/openldap
'';
};
};

1
nixos/modules/services/databases/opentsdb.nix
View File

@ -26,6 +26,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.opentsdb;
defaultText = "pkgs.opentsdb";
example = literalExample "pkgs.opentsdb";
description = ''
OpenTSDB package to use.

1
nixos/modules/services/databases/redis.nix
View File

@ -46,6 +46,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.redis;
defaultText = "pkgs.redis";
description = "Which Redis derivation to use.";
};

1
nixos/modules/services/hardware/freefall.nix
View File

@ -21,6 +21,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.freefall;
defaultText = "pkgs.freefall";
description = ''
freefall derivation to use.
'';

1
nixos/modules/services/hardware/upower.nix
View File

@ -27,6 +27,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.upower;
defaultText = "pkgs.upower";
example = lib.literalExample "pkgs.upower";
description = ''
Which upower package to use.

1
nixos/modules/services/logging/logrotate.nix
View File

@ -13,6 +13,7 @@ in
options = {
services.logrotate = {
enable = mkOption {
type = lib.types.bool;
default = false;
description = ''
Enable the logrotate cron job

3
nixos/modules/services/logging/logstash.nix
View File

@ -33,6 +33,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.logstash;
defaultText = "pkgs.logstash";
example = literalExample "pkgs.logstash";
description = "Logstash package to use.";
};
@ -84,7 +85,7 @@ in
type = types.lines;
default = ''stdin { type => "example" }'';
description = "Logstash input configuration.";
example = literalExample ''
example = ''
# Read from journal
pipe {
command => "''${pkgs.systemd}/bin/journalctl -f -o json"

1
nixos/modules/services/logging/syslog-ng.nix
View File

@ -39,6 +39,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.syslogng;
defaultText = "pkgs.syslogng";
description = ''
The package providing syslog-ng binaries.
'';

3
nixos/modules/services/mail/dovecot.nix
View File

@ -90,6 +90,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.dovecot22;
defaultText = "pkgs.dovecot22";
description = "Dovecot package to use.";
};
@ -131,7 +132,7 @@ in
modules = mkOption {
type = types.listOf types.package;
default = [];
example = [ pkgs.dovecot_pigeonhole ];
example = literalExample "[ pkgs.dovecot_pigeonhole ]";
description = ''
Symlinks the contents of lib/dovecot of every given package into
/var/lib/dovecot/modules. This will make the given modules available

3
nixos/modules/services/misc/apache-kafka.nix
View File

@ -118,9 +118,8 @@ in {
package = mkOption {
description = "The kafka package to use";
default = pkgs.apacheKafka;
defaultText = "pkgs.apacheKafka";
type = types.package;
};

3
nixos/modules/services/misc/autofs.nix
View File

@ -27,8 +27,9 @@ in
};
autoMaster = mkOption {
type = types.str;
example = literalExample ''
autoMaster = let
let
mapConf = pkgs.writeText "auto" '''
kernel -ro,soft,intr ftp.kernel.org:/pub/linux
boot -fstype=ext2 :/dev/hda1

1
nixos/modules/services/misc/cgminer.nix
View File

@ -41,6 +41,7 @@ in
package = mkOption {
default = pkgs.cgminer;
defaultText = "pkgs.cgminer";
description = "Which cgminer derivation to use.";
type = types.package;
};

1
nixos/modules/services/misc/confd.nix
View File

@ -64,6 +64,7 @@ in {
package = mkOption {
description = "Confd package to use.";
default = pkgs.confd;
defaultText = "pkgs.confd";
type = types.package;
};
};

10
nixos/modules/services/misc/etcd.nix
View File

@ -77,11 +77,11 @@ in {
default = {};
example = literalExample ''
{
"CORS": "*",
"NAME": "default-name",
"MAX_RESULT_BUFFER": "1024",
"MAX_CLUSTER_SIZE": "9",
"MAX_RETRY_ATTEMPTS": "3"
"CORS" = "*";
"NAME" = "default-name";
"MAX_RESULT_BUFFER" = "1024";
"MAX_CLUSTER_SIZE" = "9";
"MAX_RETRY_ATTEMPTS" = "3";
}
'';
};

2
nixos/modules/services/misc/felix.nix
View File

@ -23,7 +23,9 @@ in
};
bundles = mkOption {
type = types.listOf types.package;
default = [ pkgs.felix_remoteshell ];
defaultText = "[ pkgs.felix_remoteshell ]";
description = "List of bundles that should be activated on startup";
};

1
nixos/modules/services/misc/gitit.nix
View File

@ -35,6 +35,7 @@ let
};
haskellPackages = mkOption {
type = types.attrsOf types.package;
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";

1
nixos/modules/services/misc/ihaskell.nix
View File

@ -22,6 +22,7 @@ in
};
haskellPackages = mkOption {
type = types.attrsOf types.package;
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";

2
nixos/modules/services/misc/mbpfan.nix
View File

@ -17,7 +17,9 @@ in {
};
package = mkOption {
type = types.package;
default = pkgs.mbpfan;
defaultText = "pkgs.mbpfan";
description = ''
The package used for the mbpfan daemon.
'';

1
nixos/modules/services/misc/nix-daemon.nix
View File

@ -66,6 +66,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.nix;
defaultText = "pkgs.nix";
description = ''
This option specifies the Nix package instance to use throughout the system.
'';

7
nixos/modules/services/misc/rippled.nix
View File

@ -208,6 +208,7 @@ in
description = "Which rippled package to use.";
type = types.package;
default = pkgs.rippled;
defaultText = "pkgs.rippled";
};
ports = mkOption {
@ -238,7 +239,7 @@ in
nodeDb = mkOption {
description = "Rippled main database options.";
type = types.nullOr types.optionSet;
options = [dbOptions];
options = dbOptions;
default = {
type = "rocksdb";
extraOpts = ''
@ -254,14 +255,14 @@ in
tempDb = mkOption {
description = "Rippled temporary database options.";
type = types.nullOr types.optionSet;
options = [dbOptions];
options = dbOptions;
default = null;
};
importDb = mkOption {
description = "Settings for performing a one-time import.";
type = types.nullOr types.optionSet;
options = [dbOptions];
options = dbOptions;
default = null;
};

1
nixos/modules/services/monitoring/bosun.nix
View File

@ -33,6 +33,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.bosun;
defaultText = "pkgs.bosun";
example = literalExample "pkgs.bosun";
description = ''
bosun binary to use.

1
nixos/modules/services/monitoring/grafana.nix
View File

@ -93,6 +93,7 @@ in {
package = mkOption {
description = "Package to use.";
default = pkgs.grafana;
defaultText = "pkgs.grafana";
type = types.package;
};

7
nixos/modules/services/monitoring/graphite.nix
View File

@ -108,7 +108,7 @@ in {
finders = mkOption {
description = "List of finder plugins to load.";
default = [];
example = [ pkgs.python27Packages.graphite_influxdb ];
example = literalExample "[ pkgs.python27Packages.graphite_influxdb ]";
type = types.listOf types.package;
};
@ -136,6 +136,7 @@ in {
package = mkOption {
description = "Package to use for graphite api.";
default = pkgs.python27Packages.graphite_api;
defaultText = "pkgs.python27Packages.graphite_api";
type = types.package;
};
@ -146,7 +147,7 @@ in {
directories:
- ${dataDir}/whisper
'';
example = literalExample ''
example = ''
allowed_origins:
- dashboard.example.com
cheat_times: true
@ -350,7 +351,7 @@ in {
critical: 200
name: Test
'';
example = literalExample ''
example = ''
pushbullet_key: pushbullet_api_key
alerts:
- target: stats.seatgeek.app.deal_quality.venue_info_cache.hit

1
nixos/modules/services/monitoring/heapster.nix
View File

@ -33,6 +33,7 @@ in {
package = mkOption {
description = "Package to use by heapster";
default = pkgs.heapster;
defaultText = "pkgs.heapster";
type = types.package;
};
};

18
nixos/modules/services/monitoring/munin.nix
View File

@ -122,21 +122,6 @@ in
HTML output is in <filename>/var/www/munin/</filename>, configure your
favourite webserver to serve static files.
'';
example = literalExample ''
services = {
munin-node.enable = true;
munin-cron = {
enable = true;
hosts = '''
[''${config.networking.hostName}]
address localhost
''';
extraGlobalConfig = '''
contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com
''';
};
};
'';
};
extraGlobalConfig = mkOption {
@ -147,6 +132,9 @@ in
Useful to setup notifications, see
<link xlink:href='http://munin-monitoring.org/wiki/HowToContact' />
'';
example = ''
contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com
'';
};
hosts = mkOption {

6
nixos/modules/services/monitoring/nagios.nix
View File

@ -94,7 +94,9 @@ in
};
plugins = mkOption {
type = types.listOf types.package;
default = [pkgs.nagiosPluginsOfficial pkgs.ssmtp];
defaultText = "[pkgs.nagiosPluginsOfficial pkgs.ssmtp]";
description = "
Packages to be added to the Nagios <envar>PATH</envar>.
Typically used to add plugins, but can be anything.
@ -102,14 +104,18 @@ in
};
mainConfigFile = mkOption {
type = types.package;
default = nagiosCfgFile;
defaultText = "nagiosCfgFile";
description = "
Derivation for the main configuration file of Nagios.
";
};
cgiConfigFile = mkOption {
type = types.package;
default = nagiosCGICfgFile;
defaultText = "nagiosCGICfgFile";
description = "
Derivation for the configuration file of Nagios CGI scripts
that can be used in web servers for running the Nagios web interface.

3
nixos/modules/services/monitoring/scollector.nix
View File

@ -43,6 +43,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.scollector;
defaultText = "pkgs.scollector";
example = literalExample "pkgs.scollector";
description = ''
scollector binary to use.
@ -77,7 +78,7 @@ in {
collectors = mkOption {
type = with types; attrsOf (listOf path);
default = {};
example = literalExample "{ 0 = [ \"\${postgresStats}/bin/collect-stats\" ]; }";
example = literalExample "{ \"0\" = [ \"\${postgresStats}/bin/collect-stats\" ]; }";
description = ''
An attribute set mapping the frequency of collection to a list of
binaries that should be executed at that frequency. You can use "0"

3
nixos/modules/services/network-filesystems/samba.nix
View File

@ -85,7 +85,8 @@ in
package = mkOption {
type = types.package;
default = pkgs.samba;
example = pkgs.samba4;
defaultText = "pkgs.samba";
example = literalExample "pkgs.samba4";
description = ''
Defines which package should be used for the samba server.
'';

2
nixos/modules/services/networking/bind.nix
View File

@ -120,7 +120,9 @@ in
};
configFile = mkOption {
type = types.path;
default = confFile;
defaultText = "confFile";
description = "
Overridable config file to use for named. By default, that
generated by nixos.

1
nixos/modules/services/networking/consul.nix
View File

@ -118,6 +118,7 @@ in
package = mkOption {
description = "Package to use for consul-alerts.";
default = pkgs.consul-alerts;
defaultText = "pkgs.consul-alerts";
type = types.package;
};

3
nixos/modules/services/networking/firewall.nix
View File

@ -421,8 +421,9 @@ in
};
networking.firewall.extraPackages = mkOption {
type = types.listOf types.package;
default = [ ];
example = [ pkgs.ipset ];
example = literalExample "[ pkgs.ipset ]";
description =
''
Additional packages to be included in the environment of the system

1
nixos/modules/services/networking/lambdabot.nix
View File

@ -27,6 +27,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.lambdabot;
defaultText = "pkgs.lambdabot";
description = "Used lambdabot package";
};

2
nixos/modules/services/networking/networkmanager.nix
View File

@ -110,7 +110,7 @@ in {
# Ugly hack for using the correct gnome3 packageSet
basePackages = mkOption {
type = types.attrsOf types.path;
type = types.attrsOf types.package;
default = { inherit networkmanager modemmanager wpa_supplicant
networkmanager_openvpn networkmanager_vpnc
networkmanager_openconnect

1
nixos/modules/services/networking/ngircd.nix
View File

@ -34,6 +34,7 @@ in {
type = types.package;
default = pkgs.ngircd;
defaultText = "pkgs.ngircd";
};
};
};

1
nixos/modules/services/networking/skydns.nix
View File

@ -56,6 +56,7 @@ in {
package = mkOption {
default = pkgs.skydns;
defaultText = "pkgs.skydns";
type = types.package;
description = "Skydns package to use.";
};

2
nixos/modules/services/networking/supplicant.nix
View File

@ -115,7 +115,7 @@ in
path = mkOption {
type = types.path;
example = "/etc/wpa_supplicant.conf";
example = literalExample "/etc/wpa_supplicant.conf";
description = ''
External <literal>wpa_supplicant.conf</literal> configuration file.
The configuration options defined declaratively within <literal>networking.supplicant</literal> have

1
nixos/modules/services/networking/syncthing.nix
View File

@ -43,6 +43,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.syncthing;
defaultText = "pkgs.syncthing";
example = literalExample "pkgs.syncthing";
description = ''
Syncthing package to use.

2
nixos/modules/services/networking/tinc.nix
View File

@ -87,7 +87,9 @@ in
};
package = mkOption {
type = types.package;
default = pkgs.tinc_pre;
defaultText = "pkgs.tinc_pre";
description = ''
The package to use for the tinc daemon's binary.
'';

2
nixos/modules/services/networking/vsftpd.nix
View File

@ -120,7 +120,9 @@ in
};
userlistFile = mkOption {
type = types.path;
default = pkgs.writeText "userlist" (concatMapStrings (x: "${x}\n") cfg.userlist);
defaultText = "pkgs.writeText \"userlist\" (concatMapStrings (x: \"\${x}\n\") cfg.userlist)";
description = ''
Newline separated list of names to be allowed/denied if <option>userlistEnable</option>
is <literal>true</literal>. Meaning see <option>userlistDeny</option>.

1
nixos/modules/services/search/elasticsearch.nix
View File

@ -40,6 +40,7 @@ in {
package = mkOption {
description = "Elasticsearch package to use.";
default = pkgs.elasticsearch;
defaultText = "pkgs.elasticsearch";
type = types.package;
};

1
nixos/modules/services/search/kibana.nix
View File

@ -127,6 +127,7 @@ in {
package = mkOption {
description = "Kibana package to use";
default = pkgs.kibana;
defaultText = "pkgs.kibana";
type = types.package;
};

2
nixos/modules/services/search/solr.nix
View File

@ -45,6 +45,7 @@ in {
javaPackage = mkOption {
type = types.package;
default = pkgs.jre;
defaultText = "pkgs.jre";
description = ''
Which Java derivation to use for running solr.
'';
@ -53,6 +54,7 @@ in {
solrPackage = mkOption {
type = types.package;
default = pkgs.solr;
defaultText = "pkgs.solr";
description = ''
Which solr derivation to use for running solr.
'';

4
nixos/modules/services/web-servers/apache-httpd/default.nix
View File

@ -429,6 +429,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.apacheHttpd;
defaultText = "pkgs.apacheHttpd";
description = ''
Overridable attribute of the Apache HTTP Server package to use.
'';
@ -437,7 +438,8 @@ in
configFile = mkOption {
type = types.path;
default = confFile;
example = literalExample ''pkgs.writeText "httpd.conf" "# my custom config file ...";'';
defaultText = "confFile";
example = literalExample ''pkgs.writeText "httpd.conf" "# my custom config file ..."'';
description = ''
Override the configuration file used by Apache. By default,
NixOS generates one automatically.

1
nixos/modules/services/web-servers/nginx/default.nix
View File

@ -34,6 +34,7 @@ in
package = mkOption {
default = pkgs.nginx;
defaultText = "pkgs.nginx";
type = types.package;
description = "
Nginx package to use.

2
nixos/modules/services/web-servers/phpfpm.nix
View File

@ -36,7 +36,9 @@ in {
};
phpPackage = mkOption {
type = types.package;
default = pkgs.php;
defaultText = "pkgs.php";
description = ''
The PHP package to use for running the FPM service.
'';

5
nixos/modules/services/web-servers/tomcat.nix
View File

@ -24,6 +24,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.tomcat7;
defaultText = "pkgs.tomcat7";
example = lib.literalExample "pkgs.tomcat8";
description = ''
Which tomcat package to use.
@ -72,7 +73,9 @@ in
};
webapps = mkOption {
type = types.listOf types.package;
default = [ tomcat ];
defaultText = "[ tomcat ]";
description = "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat";
};
@ -87,7 +90,9 @@ in
};
jdk = mkOption {
type = types.package;
default = pkgs.jdk;
defaultText = "pkgs.jdk";
description = "Which JDK to use.";
};

1
nixos/modules/services/web-servers/winstone.nix
View File

@ -31,6 +31,7 @@ let
javaPackage = mkOption {
type = types.package;
default = pkgs.jre;
defaultText = "pkgs.jre";
description = ''
Which Java derivation to use for running Winstone.
'';

39
nixos/modules/services/web-servers/zope2.nix
View File

@ -75,25 +75,26 @@ in
services.zope2.instances = mkOption {
default = {};
type = types.loaOf types.optionSet;
example = {
plone01 = {
http_address = "127.0.0.1:8080";
extra =
''
<zodb_db main>
mount-point /
cache-size 30000
<blobstorage>
blob-dir /var/lib/zope2/plone01/blobstorage
<filestorage>
path /var/lib/zope2/plone01/filestorage/Data.fs
</filestorage>
</blobstorage>
</zodb_db>
'';
};
};
example = literalExample ''
{
plone01 = {
http_address = "127.0.0.1:8080";
extra =
'''
<zodb_db main>
mount-point /
cache-size 30000
<blobstorage>
blob-dir /var/lib/zope2/plone01/blobstorage
<filestorage>
path /var/lib/zope2/plone01/filestorage/Data.fs
</filestorage>
</blobstorage>
</zodb_db>
''';
};
}
'';
description = "zope2 instances to be created automaticaly by the system.";
options = [ zope2Opts ];
};

1
nixos/modules/services/x11/desktop-managers/gnome3.nix
View File

@ -62,6 +62,7 @@ in {
};
environment.gnome3.packageSet = mkOption {
type = types.nullOr types.package;
default = null;
example = literalExample "pkgs.gnome3_16";
description = "Which GNOME 3 package set to use.";

1
nixos/modules/services/x11/desktop-managers/kde4.nix
View File

@ -66,6 +66,7 @@ in
kdeWorkspacePackage = mkOption {
internal = true;
default = pkgs.kde4.kde_workspace;
defaultText = "pkgs.kde4.kde_workspace";
type = types.package;
description = "Custom kde-workspace, used for NixOS rebranding.";
};

6
nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix
View File

@ -67,8 +67,9 @@ in
theme = {
package = mkOption {
type = types.path;
type = types.package;
default = pkgs.gnome3.gnome_themes_standard;
defaultText = "pkgs.gnome3.gnome_themes_standard";
description = ''
The package path that contains the theme given in the name option.
'';
@ -87,8 +88,9 @@ in
iconTheme = {
package = mkOption {
type = types.path;
type = types.package;
default = pkgs.gnome3.defaultIconTheme;
defaultText = "pkgs.gnome3.defaultIconTheme";
description = ''
The package path that contains the icon theme given in the name option.
'';

3
nixos/modules/services/x11/display-managers/lightdm.nix
View File

@ -69,7 +69,7 @@ in
greeter = {
package = mkOption {
type = types.path;
type = types.package;
description = ''
The LightDM greeter to login via. The package should be a directory
containing a .desktop file matching the name in the 'name' option.
@ -86,6 +86,7 @@ in
};
background = mkOption {
type = types.path;
description = ''
The background image or color to use.
'';

4
nixos/modules/services/x11/display-managers/slim.nix
View File

@ -61,6 +61,10 @@ in
url = "https://github.com/jagajaga/nixos-slim-theme/archive/2.0.tar.gz";
sha256 = "0lldizhigx7bjhxkipii87y432hlf5wdvamnfxrryf9z7zkfypc8";
};
defaultText = ''pkgs.fetchurl {
url = "https://github.com/jagajaga/nixos-slim-theme/archive/2.0.tar.gz";
sha256 = "0lldizhigx7bjhxkipii87y432hlf5wdvamnfxrryf9z7zkfypc8";
}'';
example = literalExample ''
pkgs.fetchurl {
url = "mirror://sourceforge/slim.berlios/slim-wave.tar.gz";

1
nixos/modules/services/x11/redshift.nix
View File

@ -76,6 +76,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.redshift;
defaultText = "pkgs.redshift";
description = ''
redshift derivation to use.
'';

1
nixos/modules/services/x11/window-managers/xmonad.nix
View File

@ -16,6 +16,7 @@ in
services.xserver.windowManager.xmonad = {
enable = mkEnableOption "xmonad";
haskellPackages = mkOption {
type = lib.types.packageSet;
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";

2
nixos/modules/system/activation/top-level.nix
View File

@ -205,7 +205,7 @@ in
system.replaceRuntimeDependencies = mkOption {
default = [];
example = lib.literalExample "[ ({ original = pkgs.openssl; replacement = pkgs.callPackage /path/to/openssl { ... }; }) ]";
example = lib.literalExample "[ ({ original = pkgs.openssl; replacement = pkgs.callPackage /path/to/openssl { }; }) ]";
type = types.listOf (types.submodule (
{ options, ... }: {
options.original = mkOption {

3
nixos/modules/system/boot/kernel.nix
View File

@ -20,6 +20,7 @@ in
options = {
boot.kernelPackages = mkOption {
type = types.packageSet;
default = pkgs.linuxPackages;
# We don't want to evaluate all of linuxPackages for the manual
# - some of it might not even evaluate correctly.
@ -63,7 +64,7 @@ in
};
boot.extraModulePackages = mkOption {
type = types.listOf types.path;
type = types.listOf types.package;
default = [];
example = literalExample "[ pkgs.linuxPackages.nvidia_x11 ]";
description = "A list of additional packages supplying kernel modules.";

1
nixos/modules/system/boot/loader/grub/grub.nix
View File

@ -251,6 +251,7 @@ in
};
extraFiles = mkOption {
type = types.attrsOf types.path;
default = {};
example = literalExample ''
{ "memtest.bin" = "''${pkgs.memtest86plus}/memtest.bin"; }

2
nixos/modules/system/boot/loader/grub/ipxe.nix
View File

@ -39,7 +39,7 @@ in
dhcp
chain http://boot.ipxe.org/demo/boot.php
''';
};
}
'';
};
};

2
nixos/modules/system/boot/luksroot.nix
View File

@ -229,7 +229,7 @@ in
boot.initrd.luks.devices = mkOption {
default = [ ];
example = [ { name = "luksroot"; device = "/dev/sda3"; preLVM = true; } ];
example = literalExample ''[ { name = "luksroot"; device = "/dev/sda3"; preLVM = true; } ]'';
description = ''
The list of devices that should be decrypted using LUKS before trying to mount the
root partition. This works for both LVM-over-LUKS and LUKS-over-LVM setups.

1
nixos/modules/system/boot/systemd.nix
View File

@ -374,6 +374,7 @@ in
systemd.package = mkOption {
default = pkgs.systemd;
defaultText = "pkgs.systemd";
type = types.package;
description = "The systemd package.";
};

2
nixos/modules/tasks/network-interfaces.nix
View File

@ -355,6 +355,7 @@ in
};
networking.nameservers = mkOption {
type = types.listOf types.str;
default = [];
example = ["130.161.158.4" "130.161.33.17"];
description = ''
@ -390,6 +391,7 @@ in
};
networking.localCommands = mkOption {
type = types.str;
default = "";
example = "text=anything; echo You can put $text here.";
description = ''

1
nixos/modules/virtualisation/openvswitch.nix
View File

@ -31,6 +31,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.openvswitch;
defaultText = "pkgs.openvswitch";
description = ''
Open vSwitch package to use.
'';