From d24c02943585150c8b79b879dd6262f86134c5a1 Mon Sep 17 00:00:00 2001 From: Erik Arvstedt Date: Wed, 8 Dec 2021 04:07:27 +0100 Subject: [PATCH] treewide: add `defaultText` (manual) This enables generating module option documentation. Add `defaultText` to options where the default value can't be evaluated during metadata generation. --- modules/joinmarket.nix | 2 ++ modules/nix-bitcoin.nix | 5 +++++ modules/nodeinfo.nix | 1 + 3 files changed, 8 insertions(+) diff --git a/modules/joinmarket.nix b/modules/joinmarket.nix index 79565ad..053a376 100644 --- a/modules/joinmarket.nix +++ b/modules/joinmarket.nix @@ -44,11 +44,13 @@ let }; cli = mkOption { default = cli; + defaultText = "(See source)"; }; # Used by ./joinmarket-ob-watcher.nix ircServers = mkOption { readOnly = true; default = ircServers; + defaultText = "(See source)"; }; # This option is only used by netns-isolation. # Tor is always enabled. diff --git a/modules/nix-bitcoin.nix b/modules/nix-bitcoin.nix index 605c115..0ad9eb8 100644 --- a/modules/nix-bitcoin.nix +++ b/modules/nix-bitcoin.nix @@ -7,17 +7,20 @@ with lib; pkgs = mkOption { type = types.attrs; default = (import ../pkgs { inherit pkgs; }).modulesPkgs; + defaultText = "nix-bitcoin/pkgs.modulesPkgs"; }; lib = mkOption { readOnly = true; default = import ../pkgs/lib.nix lib pkgs; + defaultText = "nix-bitcoin/pkgs/lib.nix"; }; torClientAddressWithPort = mkOption { readOnly = true; default = with config.services.tor.client.socksListenAddress; "${addr}:${toString port}"; + defaultText = "(See source)"; }; # Torify binary that works with custom Tor SOCKS addresses @@ -29,6 +32,7 @@ with lib; --address ${config.services.tor.client.socksListenAddress.addr} \ "$@" ''; + defaultText = "(See source)"; }; # A helper for using doas instead of sudo when doas is enabled @@ -38,6 +42,7 @@ with lib; # TODO-EXTERNAL: Use absolute path until https://github.com/NixOS/nixpkgs/pull/133622 is available. then "/run/wrappers/bin/doas -u" else "sudo -u"; + defaultText = "(See source)"; }; }; }; diff --git a/modules/nodeinfo.nix b/modules/nodeinfo.nix index bafd38d..1c3d544 100644 --- a/modules/nodeinfo.nix +++ b/modules/nodeinfo.nix @@ -8,6 +8,7 @@ let program = mkOption { readOnly = true; default = script; + defaultText = "(See source)"; }; }; };