From 6039648c50c7c0858b5e506c6298773a98e0f066 Mon Sep 17 00:00:00 2001 From: pennae Date: Mon, 15 Aug 2022 07:16:25 +0200 Subject: nixos/*: automatically convert option docs --- nixos/modules/services/databases/foundationdb.nix | 4 ++-- nixos/modules/services/databases/mongodb.nix | 2 +- nixos/modules/services/databases/mysql.nix | 2 +- nixos/modules/services/databases/postgresql.nix | 6 +++--- 4 files changed, 7 insertions(+), 7 deletions(-) (limited to 'nixos/modules/services/databases') diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix index f71228708e426..16998b9979185 100644 --- a/nixos/modules/services/databases/foundationdb.nix +++ b/nixos/modules/services/databases/foundationdb.nix @@ -97,9 +97,9 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open the firewall ports corresponding to FoundationDB processes and coordinators - using . + using {option}`config.networking.firewall.*`. ''; }; diff --git a/nixos/modules/services/databases/mongodb.nix b/nixos/modules/services/databases/mongodb.nix index 97713b5d6e1bd..5a52eb98b917e 100644 --- a/nixos/modules/services/databases/mongodb.nix +++ b/nixos/modules/services/databases/mongodb.nix @@ -35,7 +35,7 @@ in default = pkgs.mongodb; defaultText = literalExpression "pkgs.mongodb"; type = types.package; - description = '' + description = lib.mdDoc '' Which MongoDB derivation to use. ''; }; diff --git a/nixos/modules/services/databases/mysql.nix b/nixos/modules/services/databases/mysql.nix index a42926a542f2d..ddb4eceb317e1 100644 --- a/nixos/modules/services/databases/mysql.nix +++ b/nixos/modules/services/databases/mysql.nix @@ -36,7 +36,7 @@ in package = mkOption { type = types.package; example = literalExpression "pkgs.mariadb"; - description = '' + description = lib.mdDoc '' Which MySQL derivation to use. MariaDB packages are supported too. ''; }; diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index 1a57ecbe8ef34..36de8b9e874ae 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -79,15 +79,15 @@ in authentication = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Defines how users authenticate themselves to the server. See the - PostgreSQL documentation for pg_hba.conf + [PostgreSQL documentation for pg_hba.conf](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html) for details on the expected format of this option. By default, peer based authentication will be used for users connecting via the Unix socket, and md5 password authentication will be used for users connecting via TCP. Any added rules will be inserted above the default rules. If you'd like to replace the - default rules entirely, you can use lib.mkForce in your + default rules entirely, you can use `lib.mkForce` in your module. ''; }; -- cgit 1.4.1