2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
63 lines
1.8 KiB
Nix
63 lines
1.8 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
let
|
|
cfg = config.services.inspircd;
|
|
|
|
configFile = pkgs.writeText "inspircd.conf" cfg.config;
|
|
|
|
in {
|
|
meta = {
|
|
maintainers = [ lib.maintainers.sternenseemann ];
|
|
};
|
|
|
|
options = {
|
|
services.inspircd = {
|
|
enable = lib.mkEnableOption "InspIRCd";
|
|
|
|
package = lib.mkOption {
|
|
type = lib.types.package;
|
|
default = pkgs.inspircd;
|
|
defaultText = lib.literalExpression "pkgs.inspircd";
|
|
example = lib.literalExpression "pkgs.inspircdMinimal";
|
|
description = lib.mdDoc ''
|
|
The InspIRCd package to use. This is mainly useful
|
|
to specify an overridden version of the
|
|
`pkgs.inspircd` dervivation, for
|
|
example if you want to use a more minimal InspIRCd
|
|
distribution with less modules enabled or with
|
|
modules enabled which can't be distributed in binary
|
|
form due to licensing issues.
|
|
'';
|
|
};
|
|
|
|
config = lib.mkOption {
|
|
type = lib.types.lines;
|
|
description = lib.mdDoc ''
|
|
Verbatim `inspircd.conf` file.
|
|
For a list of options, consult the
|
|
[InspIRCd documentation](https://docs.inspircd.org/3/configuration/), the
|
|
[Module documentation](https://docs.inspircd.org/3/modules/)
|
|
and the example configuration files distributed
|
|
with `pkgs.inspircd.doc`
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = lib.mkIf cfg.enable {
|
|
systemd.services.inspircd = {
|
|
description = "InspIRCd - the stable, high-performance and modular Internet Relay Chat Daemon";
|
|
wantedBy = [ "multi-user.target" ];
|
|
requires = [ "network.target" ];
|
|
|
|
serviceConfig = {
|
|
Type = "simple";
|
|
ExecStart = ''
|
|
${lib.getBin cfg.package}/bin/inspircd start --config ${configFile} --nofork --nopid
|
|
'';
|
|
DynamicUser = true;
|
|
};
|
|
};
|
|
};
|
|
}
|