diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/networking/bitcoind.nix')
-rw-r--r-- | nixpkgs/nixos/modules/services/networking/bitcoind.nix | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/nixpkgs/nixos/modules/services/networking/bitcoind.nix b/nixpkgs/nixos/modules/services/networking/bitcoind.nix index 80033d958609..1788d5fcf58d 100644 --- a/nixpkgs/nixos/modules/services/networking/bitcoind.nix +++ b/nixpkgs/nixos/modules/services/networking/bitcoind.nix @@ -11,7 +11,7 @@ let name = mkOption { type = types.str; example = "alice"; - description = '' + description = lib.mdDoc '' Username for JSON-RPC connections. ''; }; @@ -41,14 +41,14 @@ let type = types.package; default = pkgs.bitcoind; defaultText = literalExpression "pkgs.bitcoind"; - description = "The package providing bitcoin binaries."; + description = lib.mdDoc "The package providing bitcoin binaries."; }; configFile = mkOption { type = types.nullOr types.path; default = null; example = "/var/lib/${name}/bitcoin.conf"; - description = "The configuration file path to supply bitcoind."; + description = lib.mdDoc "The configuration file path to supply bitcoind."; }; extraConfig = mkOption { @@ -59,32 +59,32 @@ let rpcthreads=16 logips=1 ''; - description = "Additional configurations to be appended to <filename>bitcoin.conf</filename>."; + description = lib.mdDoc "Additional configurations to be appended to {file}`bitcoin.conf`."; }; dataDir = mkOption { type = types.path; default = "/var/lib/bitcoind-${name}"; - description = "The data directory for bitcoind."; + description = lib.mdDoc "The data directory for bitcoind."; }; user = mkOption { type = types.str; default = "bitcoind-${name}"; - description = "The user as which to run bitcoind."; + description = lib.mdDoc "The user as which to run bitcoind."; }; group = mkOption { type = types.str; default = config.user; - description = "The group as which to run bitcoind."; + description = lib.mdDoc "The group as which to run bitcoind."; }; rpc = { port = mkOption { type = types.nullOr types.port; default = null; - description = "Override the default port on which to listen for JSON-RPC connections."; + description = lib.mdDoc "Override the default port on which to listen for JSON-RPC connections."; }; users = mkOption { default = {}; @@ -95,33 +95,33 @@ let } ''; type = types.attrsOf (types.submodule rpcUserOpts); - description = "RPC user information for JSON-RPC connnections."; + description = lib.mdDoc "RPC user information for JSON-RPC connnections."; }; }; pidFile = mkOption { type = types.path; default = "${config.dataDir}/bitcoind.pid"; - description = "Location of bitcoind pid file."; + description = lib.mdDoc "Location of bitcoind pid file."; }; testnet = mkOption { type = types.bool; default = false; - description = "Whether to use the testnet instead of mainnet."; + description = lib.mdDoc "Whether to use the testnet instead of mainnet."; }; port = mkOption { type = types.nullOr types.port; default = null; - description = "Override the default port on which to listen for connections."; + description = lib.mdDoc "Override the default port on which to listen for connections."; }; dbCache = mkOption { type = types.nullOr (types.ints.between 4 16384); default = null; example = 4000; - description = "Override the default database cache size in MiB."; + description = lib.mdDoc "Override the default database cache size in MiB."; }; prune = mkOption { @@ -132,7 +132,7 @@ let ); default = null; example = 10000; - description = '' + description = lib.mdDoc '' Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a @@ -147,7 +147,7 @@ let extraCmdlineOptions = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra command line options to pass to bitcoind. Run bitcoind --help to list all available options. ''; @@ -161,7 +161,7 @@ in services.bitcoind = mkOption { type = types.attrsOf (types.submodule bitcoindOpts); default = {}; - description = "Specification of one or more bitcoind instances."; + description = lib.mdDoc "Specification of one or more bitcoind instances."; }; }; |