nix-community/nix-on-droid
1
0
Fork 0
mirror of https://github.com/nix-community/nix-on-droid.git synced 2025-11-08 19:46:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

fixup svd: mdDoc-ify everything

Browse source
This commit is contained in:
Zhaofeng Li 2022-09-21 18:28:28 +00:00
parent 88b5731333
commit a00dc02a84
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
modules/supervisord.nix
View file

@ -9,42 +9,42 @@ let
programType = types.submodule ({ name, config, ... }: {
options = {
enable = lib.mkOption {
description = ''
description = lib.mdDoc ''
Whether to enable this program.
'';
type = types.bool;
default = true;
};
command = lib.mkOption {
description = ''
description = lib.mdDoc ''
The command that will be run as the service's main process.
'';
type = types.str;
default = toString (pkgs.writeShellScript "${name}-script.sh" config.script);
};
script = lib.mkOption {
description = ''
description = lib.mdDoc ''
Shell commands executed as the service's main process.
'';
type = types.lines;
default = "";
};
path = lib.mkOption {
description = ''
description = lib.mdDoc ''
Packages added to the service's PATH environment variable.
'';
type = types.listOf (types.either types.package types.str);
default = [];
};
autoRestart = lib.mkOption {
description = ''
description = lib.mdDoc ''
Whether to automatically restart the process if it exits.
'';
type = types.either types.bool (types.enum [ "false" "true" "unexpected" ]);
default = "unexpected";
};
environment = lib.mkOption {
description = ''
description = lib.mdDoc ''
Environment variables passed to the service's process.
'';
type = types.attrsOf types.str;
@ -53,7 +53,7 @@ let
};
};
extraConfig = lib.mkOption {
description = ''
description = lib.mdDoc ''
Extra structured configurations to add to the [program:x] section.
'';
type = types.attrsOf types.str;
@ -111,7 +111,7 @@ in {
options = {
supervisord = {
enable = lib.mkOption {
description = ''
description = lib.mdDoc ''
Whether to enable the supervisord process control system.
This allows you to define long-running services in Nix-on-Droid.
@ -120,7 +120,7 @@ in {
default = numPrograms != 0;
};
package = lib.mkOption {
description = ''
description = lib.mdDoc ''
The supervisord package to use.
'';
type = types.package;
@ -128,14 +128,14 @@ in {
defaultText = lib.literalExpression "pkgs.python3Packages.supervisor";
};
socketPath = lib.mkOption {
description = ''
description = lib.mdDoc ''
Path to the UNIX domain socket on which supervisord will listen on.
'';
type = types.path;
default = "/tmp/supervisor.sock";
};
pidPath = lib.mkOption {
description = ''
description = lib.mdDoc ''
Path to the file in which supervisord saves its PID.
'';
type = types.path;
@ -149,7 +149,7 @@ in {
default = "/tmp/supervisor.log";
};
programs = lib.mkOption {
description = ''
description = lib.mdDoc ''
Definition of supervisord programs.
'';
type = types.attrsOf programType;