diff options
author | nicoo <nicoo@mur.at> | 2023-05-26 16:44:44 +0000 |
---|---|---|
committer | nicoo <nicoo@mur.at> | 2023-05-27 11:52:07 +0000 |
commit | 942f0a01fe34014763d0a602e2d97b7b92a33e6b (patch) | |
tree | 68a72689b80ecd50ae3ec782ddd26b3f2669207c /nixos/modules/services/monitoring/below.nix | |
parent | 405e1f1e54ecdf66e6a00c965e8a561498287b03 (diff) | |
download | nixpkgs-942f0a01fe34014763d0a602e2d97b7b92a33e6b.tar nixpkgs-942f0a01fe34014763d0a602e2d97b7b92a33e6b.tar.gz nixpkgs-942f0a01fe34014763d0a602e2d97b7b92a33e6b.tar.bz2 nixpkgs-942f0a01fe34014763d0a602e2d97b7b92a33e6b.tar.lz nixpkgs-942f0a01fe34014763d0a602e2d97b7b92a33e6b.tar.xz nixpkgs-942f0a01fe34014763d0a602e2d97b7b92a33e6b.tar.zst nixpkgs-942f0a01fe34014763d0a602e2d97b7b92a33e6b.zip |
nixos/below: Explicitely mark descriptions as using Markdown
Diffstat (limited to 'nixos/modules/services/monitoring/below.nix')
-rw-r--r-- | nixos/modules/services/monitoring/below.nix | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/nixos/modules/services/monitoring/below.nix b/nixos/modules/services/monitoring/below.nix index b1f38c7f820..92ee3882cac 100644 --- a/nixos/modules/services/monitoring/below.nix +++ b/nixos/modules/services/monitoring/below.nix @@ -13,12 +13,13 @@ let mkDisableOption = n: mkOption { type = types.bool; default = true; - description = "Whether to enable ${n}."; + description = mdDoc "Whether to enable ${n}."; }; - optionalType = ty: x: mkOption ({ + optionalType = ty: x: mkOption (x // { + description = mdDoc x.description; type = (types.nullOr ty); default = null; - } // x); + }); optionalPath = optionalType types.path; optionalStr = optionalType types.str; optionalInt = optionalType types.int; @@ -33,13 +34,13 @@ in { }; collect = { diskStats = mkDisableOption "dist_stat collection"; - ioStats = mkEnableOption "io.stat collection for cgroups"; + ioStats = mkEnableOption (mdDoc "io.stat collection for cgroups"); exitStats = mkDisableOption "eBPF-based exitstats"; }; - compression.enable = mkEnableOption "data compression"; + compression.enable = mkEnableOption (mdDoc "data compression"); retention = { size = optionalInt { - description = mdDoc '' + description = '' Size limit for below's data, in bytes. Data is deleted oldest-first, in 24h 'shards'. ::: {.note} @@ -50,7 +51,7 @@ in { ''; }; time = optionalInt { - description = mdDoc '' + description = '' Retention time, in seconds. ::: {.note} |