diff options
author | pennae <github@quasiparticle.net> | 2022-08-03 22:46:41 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-08-03 22:46:41 +0200 |
commit | 61e93df1891972bae3e0c97a477bd44e8a477aa0 (patch) | |
tree | 4285c1d22db537fb02baf1e978eb4434b0276b0c /nixos/modules/services/logging | |
parent | 645cfa59ac5690187eac40ef2ac67381668acecc (diff) | |
download | nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.gz nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.bz2 nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.lz nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.xz nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.zst nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.zip |
nixos/*: automatically convert option docs to MD
once again using nix-doc-munge (https://github.com/pennae/nix-doc-munge/commit/69d080323ae27c0d8da3967c62b925a9aedb2828)
Diffstat (limited to 'nixos/modules/services/logging')
-rw-r--r-- | nixos/modules/services/logging/filebeat.nix | 20 | ||||
-rw-r--r-- | nixos/modules/services/logging/logrotate.nix | 10 |
2 files changed, 15 insertions, 15 deletions
diff --git a/nixos/modules/services/logging/filebeat.nix b/nixos/modules/services/logging/filebeat.nix index 045cd1147ea..3dc9df372ac 100644 --- a/nixos/modules/services/logging/filebeat.nix +++ b/nixos/modules/services/logging/filebeat.nix @@ -31,20 +31,20 @@ in }; inputs = mkOption { - description = '' + description = lib.mdDoc '' Inputs specify how Filebeat locates and processes input data. - This is like <literal>services.filebeat.settings.filebeat.inputs</literal>, + This is like `services.filebeat.settings.filebeat.inputs`, but structured as an attribute set. This has the benefit that multiple NixOS modules can contribute settings to a single filebeat input. An input type can be specified multiple times by choosing a - different <literal><name></literal> for each, but setting - <xref linkend="opt-services.filebeat.inputs._name_.type"/> + different `<name>` for each, but setting + [](#opt-services.filebeat.inputs._name_.type) to the same value. - See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html"/>. + See <https://www.elastic.co/guide/en/beats/filebeat/current/configuration-filebeat-options.html>. ''; default = {}; type = types.attrsOf (types.submodule ({ name, ... }: { @@ -77,24 +77,24 @@ in }; modules = mkOption { - description = '' + description = lib.mdDoc '' Filebeat modules provide a quick way to get started processing common log formats. They contain default configurations, Elasticsearch ingest pipeline definitions, and Kibana dashboards to help you implement and deploy a log monitoring solution. - This is like <literal>services.filebeat.settings.filebeat.modules</literal>, + This is like `services.filebeat.settings.filebeat.modules`, but structured as an attribute set. This has the benefit that multiple NixOS modules can contribute settings to a single filebeat module. A module can be specified multiple times by choosing a - different <literal><name></literal> for each, but setting - <xref linkend="opt-services.filebeat.modules._name_.module"/> + different `<name>` for each, but setting + [](#opt-services.filebeat.modules._name_.module) to the same value. - See <link xlink:href="https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html"/>. + See <https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html>. ''; default = {}; type = types.attrsOf (types.submodule ({ name, ... }: { diff --git a/nixos/modules/services/logging/logrotate.nix b/nixos/modules/services/logging/logrotate.nix index a6eb08ac5ea..53230cc51e5 100644 --- a/nixos/modules/services/logging/logrotate.nix +++ b/nixos/modules/services/logging/logrotate.nix @@ -276,9 +276,9 @@ in defaultText = '' A configuration file automatically generated by NixOS. ''; - description = '' + description = lib.mdDoc '' Override the configuration file used by MySQL. By default, - NixOS generates one automatically from <xref linkend="opt-services.logrotate.settings"/>. + NixOS generates one automatically from [](#opt-services.logrotate.settings). ''; example = literalExpression '' pkgs.writeText "logrotate.conf" ''' @@ -346,11 +346,11 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra contents to append to the logrotate configuration file. Refer to - <link xlink:href="https://linux.die.net/man/8/logrotate"/> for details. + <https://linux.die.net/man/8/logrotate> for details. This setting has been deprecated in favor of - <link linkend="opt-services.logrotate.settings">logrotate settings</link>. + [logrotate settings](#opt-services.logrotate.settings). ''; }; }; |