mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-24 22:50:49 +00:00
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:
parent
fd73d2b13b
commit
6ce8f753e0
|
@ -27,37 +27,37 @@ in {
|
|||
|
||||
options.services.elasticsearch = {
|
||||
enable = mkOption {
|
||||
description = "Whether to enable elasticsearch";
|
||||
description = "Whether to enable elasticsearch.";
|
||||
default = false;
|
||||
type = types.uniq types.bool;
|
||||
};
|
||||
|
||||
host = mkOption {
|
||||
description = "Elasticsearch listen address";
|
||||
description = "Elasticsearch listen address.";
|
||||
default = "127.0.0.1";
|
||||
type = types.str;
|
||||
};
|
||||
|
||||
port = mkOption {
|
||||
description = "Elasticsearch port to listen for HTTP traffic";
|
||||
description = "Elasticsearch port to listen for HTTP traffic.";
|
||||
default = 9200;
|
||||
type = types.int;
|
||||
};
|
||||
|
||||
tcp_port = mkOption {
|
||||
description = "Elasticsearch port for the node to node communication";
|
||||
description = "Elasticsearch port for the node to node communication.";
|
||||
default = 9300;
|
||||
type = types.int;
|
||||
};
|
||||
|
||||
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";
|
||||
type = types.str;
|
||||
};
|
||||
|
||||
extraConf = mkOption {
|
||||
description = "Extra configuration for elasticsearch";
|
||||
description = "Extra configuration for elasticsearch.";
|
||||
default = "";
|
||||
type = types.str;
|
||||
example = ''
|
||||
|
@ -70,7 +70,7 @@ in {
|
|||
};
|
||||
|
||||
logging = mkOption {
|
||||
description = "Elasticsearch logging configuration";
|
||||
description = "Elasticsearch logging configuration.";
|
||||
default = ''
|
||||
rootLogger: INFO, console
|
||||
logger:
|
||||
|
@ -95,7 +95,7 @@ in {
|
|||
};
|
||||
|
||||
extraCmdLineOptions = mkOption {
|
||||
description = "Extra command line options for the elasticsearch launcher";
|
||||
description = "Extra command line options for the elasticsearch launcher.";
|
||||
default = [];
|
||||
type = types.listOf types.string;
|
||||
example = [ "-Djava.net.preferIPv4Stack=true" ];
|
||||
|
|
Loading…
Reference in a new issue