treewide: use mdDoc for descriptions

Enable markdown syntax (instead of docbook) for descriptions.
This only affects external doc tooling that renders the descriptions.
This commit is contained in:
Erik Arvstedt
2022-12-18 13:13:47 +01:00
parent a9c1995ed9
commit 109dccca27
33 changed files with 292 additions and 292 deletions

View File

@@ -12,23 +12,25 @@ let
access = mkOption {
type = with types; attrsOf (listOf str);
default = {};
description = ''
description = mdDoc ''
This option controls who is allowed to access onion addresses.
For example, the following allows user 'myuser' to access bitcoind
and clightning onion addresses:
```nix
{
"myuser" = [ "bitcoind" "clightning" ];
};
```
The onion hostnames can then be read from
/var/lib/onion-addresses/myuser.
{file}`/var/lib/onion-addresses/myuser`.
'';
};
services = mkOption {
type = with types; listOf str;
default = [];
description = ''
description = mdDoc ''
Services that can access their onion address via file
`/var/lib/onion-addresses/$service`
{file}`/var/lib/onion-addresses/<service>`
The file is readable only by the service user.
'';
};