nixos/elasticsearch: add '.' at end of description strings

Nixos option descriptions should be full sentences, ending in a full
stop. (Package descriptions, on the other hand, should not.)
This commit is contained in:
Bjørn Forsman 2014-06-24 21:04:56 +02:00
parent fd73d2b13b
commit 6ce8f753e0

View File

@ -27,37 +27,37 @@ in {
options.services.elasticsearch = { options.services.elasticsearch = {
enable = mkOption { enable = mkOption {
description = "Whether to enable elasticsearch"; description = "Whether to enable elasticsearch.";
default = false; default = false;
type = types.uniq types.bool; type = types.uniq types.bool;
}; };
host = mkOption { host = mkOption {
description = "Elasticsearch listen address"; description = "Elasticsearch listen address.";
default = "127.0.0.1"; default = "127.0.0.1";
type = types.str; type = types.str;
}; };
port = mkOption { port = mkOption {
description = "Elasticsearch port to listen for HTTP traffic"; description = "Elasticsearch port to listen for HTTP traffic.";
default = 9200; default = 9200;
type = types.int; type = types.int;
}; };
tcp_port = mkOption { tcp_port = mkOption {
description = "Elasticsearch port for the node to node communication"; description = "Elasticsearch port for the node to node communication.";
default = 9300; default = 9300;
type = types.int; type = types.int;
}; };
cluster_name = mkOption { cluster_name = mkOption {
description = "Elasticsearch name that identifies your cluster for auto-discovery"; description = "Elasticsearch name that identifies your cluster for auto-discovery.";
default = "elasticsearch"; default = "elasticsearch";
type = types.str; type = types.str;
}; };
extraConf = mkOption { extraConf = mkOption {
description = "Extra configuration for elasticsearch"; description = "Extra configuration for elasticsearch.";
default = ""; default = "";
type = types.str; type = types.str;
example = '' example = ''
@ -70,7 +70,7 @@ in {
}; };
logging = mkOption { logging = mkOption {
description = "Elasticsearch logging configuration"; description = "Elasticsearch logging configuration.";
default = '' default = ''
rootLogger: INFO, console rootLogger: INFO, console
logger: logger:
@ -95,7 +95,7 @@ in {
}; };
extraCmdLineOptions = mkOption { extraCmdLineOptions = mkOption {
description = "Extra command line options for the elasticsearch launcher"; description = "Extra command line options for the elasticsearch launcher.";
default = []; default = [];
type = types.listOf types.string; type = types.listOf types.string;
example = [ "-Djava.net.preferIPv4Stack=true" ]; example = [ "-Djava.net.preferIPv4Stack=true" ];