aiolabs/nix-bitcoin
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

treewide: use mdDoc for descriptions

Browse source 
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
No known key found for this signature in database
GPG key ID: 33312B944DD97846
33 changed files with 292 additions and 292 deletions
Download patch file Download diff file Expand all files Collapse all files

10
modules/onion-services.nix
View file

@ -16,24 +16,24 @@ let
enable = mkOption {
type = types.bool;
default = config.public;
description = ''
description = mdDoc ''
Create an onion service for the given service.
The service must define options 'address' and 'onionPort' (or `port`).
The service must define options {option}'address' and {option}'onionPort' (or `port`).
'';
};
public = mkOption {
type = types.bool;
default = false;
description = ''
description = mdDoc ''
Make the onion address accessible to the service.
If enabled, the onion service is automatically enabled.
Only available for services that define option `getPublicAddressCmd`.
Only available for services that define option {option}`getPublicAddressCmd`.
'';
};
externalPort = mkOption {
type = types.nullOr types.port;
default = null;
description = "Override the external port of the onion service.";
description = mdDoc "Override the external port of the onion service.";
};
};
}