diff options
author | stuebinm <stuebinm@disroot.org> | 2024-04-13 14:54:15 +0200 |
---|---|---|
committer | Jonathan Ringer <jonringer@users.noreply.github.com> | 2024-04-13 10:07:35 -0700 |
commit | 6afb255d976f85f3359e4929abd6f5149c323a02 (patch) | |
tree | ced23a118ee0852174d31005acd16f04cad3a781 /nixos/modules/services/video | |
parent | 1dd996e59a5e67694b7a252aacba71a88d51b41e (diff) |
nixos: remove all uses of lib.mdDoc
these changes were generated with nixq 0.0.2, by running
nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix
two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.
Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
Diffstat (limited to 'nixos/modules/services/video')
-rw-r--r-- | nixos/modules/services/video/epgstation/default.nix | 26 | ||||
-rw-r--r-- | nixos/modules/services/video/frigate.nix | 21 | ||||
-rw-r--r-- | nixos/modules/services/video/go2rtc/default.nix | 11 | ||||
-rw-r--r-- | nixos/modules/services/video/mediamtx.nix | 10 | ||||
-rw-r--r-- | nixos/modules/services/video/mirakurun.nix | 16 | ||||
-rw-r--r-- | nixos/modules/services/video/photonvision.nix | 4 | ||||
-rw-r--r-- | nixos/modules/services/video/replay-sorcery.nix | 10 | ||||
-rw-r--r-- | nixos/modules/services/video/unifi-video.nix | 12 | ||||
-rw-r--r-- | nixos/modules/services/video/v4l2-relayd.nix | 22 |
9 files changed, 65 insertions, 67 deletions
diff --git a/nixos/modules/services/video/epgstation/default.nix b/nixos/modules/services/video/epgstation/default.nix index 1b3258c3df8e..3bf7e5849251 100644 --- a/nixos/modules/services/video/epgstation/default.nix +++ b/nixos/modules/services/video/epgstation/default.nix @@ -78,7 +78,7 @@ in ]; options.services.epgstation = { - enable = lib.mkEnableOption (lib.mdDoc description); + enable = lib.mkEnableOption description; package = lib.mkPackageOption pkgs "epgstation" { }; @@ -90,7 +90,7 @@ in usePreconfiguredStreaming = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Use preconfigured default streaming options. Upstream defaults: @@ -101,7 +101,7 @@ in openFirewall = lib.mkOption { type = lib.types.bool; default = false; - description = lib.mdDoc '' + description = '' Open ports in the firewall for the EPGStation web interface. ::: {.warning} @@ -116,7 +116,7 @@ in name = lib.mkOption { type = lib.types.str; default = "epgstation"; - description = lib.mdDoc '' + description = '' Name of the MySQL database that holds EPGStation's data. ''; }; @@ -124,7 +124,7 @@ in passwordFile = lib.mkOption { type = lib.types.path; example = "/run/keys/epgstation-db-password"; - description = lib.mdDoc '' + description = '' A file containing the password for the database named {option}`database.name`. ''; @@ -142,7 +142,7 @@ in # configure them according to their needs. In these cases, the value in the # upstream template configuration should serve as a "good enough" default. settings = lib.mkOption { - description = lib.mdDoc '' + description = '' Options to add to config.yml. Documentation: @@ -161,7 +161,7 @@ in options.port = lib.mkOption { type = lib.types.port; default = 20772; - description = lib.mdDoc '' + description = '' HTTP port for EPGStation to listen on. ''; }; @@ -170,7 +170,7 @@ in type = lib.types.port; default = cfg.settings.port + 1; defaultText = lib.literalExpression "config.${opt.settings}.port + 1"; - description = lib.mdDoc '' + description = '' Socket.io port for EPGStation to listen on. It is valid to share ports with {option}`${opt.settings}.port`. ''; @@ -180,7 +180,7 @@ in type = lib.types.port; default = cfg.settings.socketioPort; defaultText = lib.literalExpression "config.${opt.settings}.socketioPort"; - description = lib.mdDoc '' + description = '' Socket.io port that the web client is going to connect to. This may be different from {option}`${opt.settings}.socketioPort` if EPGStation is hidden behind a reverse proxy. @@ -194,13 +194,13 @@ in "http+unix://''${lib.replaceStrings ["/"] ["%2F"] config.${option}}" ''; example = "http://localhost:40772"; - description = lib.mdDoc "URL to connect to Mirakurun."; + description = "URL to connect to Mirakurun."; }; options.encodeProcessNum = lib.mkOption { type = lib.types.ints.positive; default = 4; - description = lib.mdDoc '' + description = '' The maximum number of processes that EPGStation would allow to run at the same time for encoding or streaming videos. ''; @@ -209,7 +209,7 @@ in options.concurrentEncodeNum = lib.mkOption { type = lib.types.ints.positive; default = 1; - description = lib.mdDoc '' + description = '' The maximum number of encoding jobs that EPGStation would run at the same time. ''; @@ -217,7 +217,7 @@ in options.encode = lib.mkOption { type = with lib.types; listOf attrs; - description = lib.mdDoc "Encoding presets for recorded videos."; + description = "Encoding presets for recorded videos."; default = [ { name = "H.264"; diff --git a/nixos/modules/services/video/frigate.nix b/nixos/modules/services/video/frigate.nix index 0c923a20c40c..0e6bde447c03 100644 --- a/nixos/modules/services/video/frigate.nix +++ b/nixos/modules/services/video/frigate.nix @@ -8,7 +8,6 @@ let inherit (lib) literalExpression mkDefault - mdDoc mkEnableOption mkPackageOption mkIf @@ -26,7 +25,7 @@ let options = { ffmpeg = { inputs = mkOption { - description = mdDoc '' + description = '' List of inputs for this camera. ''; type = listOf (submodule { @@ -35,7 +34,7 @@ let path = mkOption { type = str; example = "rtsp://192.0.2.1:554/rtsp"; - description = mdDoc '' + description = '' Stream URL ''; }; @@ -44,7 +43,7 @@ let example = literalExpression '' [ "detect" "rtmp" ] ''; - description = mdDoc '' + description = '' List of roles for this stream ''; }; @@ -61,14 +60,14 @@ in meta.buildDocsInSandbox = false; options.services.frigate = with types; { - enable = mkEnableOption (mdDoc "Frigate NVR"); + enable = mkEnableOption "Frigate NVR"; package = mkPackageOption pkgs "frigate" { }; hostname = mkOption { type = str; example = "frigate.exampe.com"; - description = mdDoc '' + description = '' Hostname of the nginx vhost to configure. Only nginx is supported by upstream for direct reverse proxying. @@ -81,7 +80,7 @@ in options = { cameras = mkOption { type = attrsOf cameraFormat; - description = mdDoc '' + description = '' Attribute set of cameras configurations. https://docs.frigate.video/configuration/cameras @@ -92,20 +91,20 @@ in path = mkOption { type = path; default = "/var/lib/frigate/frigate.db"; - description = mdDoc '' + description = '' Path to the SQLite database used ''; }; }; mqtt = { - enabled = mkEnableOption (mdDoc "MQTT support"); + enabled = mkEnableOption "MQTT support"; host = mkOption { type = nullOr str; default = null; example = "mqtt.example.com"; - description = mdDoc '' + description = '' MQTT server hostname ''; }; @@ -113,7 +112,7 @@ in }; }; default = { }; - description = mdDoc '' + description = '' Frigate configuration as a nix attribute set. See the project documentation for how to configure frigate. diff --git a/nixos/modules/services/video/go2rtc/default.nix b/nixos/modules/services/video/go2rtc/default.nix index 9dddbb60baa8..399f4d582171 100644 --- a/nixos/modules/services/video/go2rtc/default.nix +++ b/nixos/modules/services/video/go2rtc/default.nix @@ -8,7 +8,6 @@ let inherit (lib) literalExpression - mdDoc mkEnableOption mkOption mkPackageOption @@ -26,13 +25,13 @@ in meta.buildDocsInSandbox = false; options.services.go2rtc = with types; { - enable = mkEnableOption (mdDoc "go2rtc streaming server"); + enable = mkEnableOption "go2rtc streaming server"; package = mkPackageOption pkgs "go2rtc" { }; settings = mkOption { default = {}; - description = mdDoc '' + description = '' go2rtc configuration as a Nix attribute set. See the [wiki](https://github.com/AlexxIT/go2rtc/wiki/Configuration) for possible configuration options. @@ -46,7 +45,7 @@ in type = str; default = ":1984"; example = "127.0.0.1:1984"; - description = mdDoc '' + description = '' API listen address, conforming to a Go address string. ''; }; @@ -58,7 +57,7 @@ in type = path; default = "${lib.getBin pkgs.ffmpeg_6-headless}/bin/ffmpeg"; defaultText = literalExpression "\${lib.getBin pkgs.ffmpeg_6-headless}/bin/ffmpeg"; - description = mdDoc '' + description = '' The ffmpeg package to use for transcoding. ''; }; @@ -77,7 +76,7 @@ in cam2 = "tcp://192.168.1.123:12345"; } ''; - description = mdDoc '' + description = '' Stream source configuration. Multiple source types are supported. Check the [configuration reference](https://github.com/AlexxIT/go2rtc/blob/v${cfg.package.version}/README.md#module-streams) for possible options. diff --git a/nixos/modules/services/video/mediamtx.nix b/nixos/modules/services/video/mediamtx.nix index f741dea59e3e..5d8d76be69a3 100644 --- a/nixos/modules/services/video/mediamtx.nix +++ b/nixos/modules/services/video/mediamtx.nix @@ -9,12 +9,12 @@ in options = { services.mediamtx = { - enable = lib.mkEnableOption (lib.mdDoc "MediaMTX"); + enable = lib.mkEnableOption "MediaMTX"; package = lib.mkPackageOption pkgs "mediamtx" { }; settings = lib.mkOption { - description = lib.mdDoc '' + description = '' Settings for MediaMTX. Refer to the defaults at <https://github.com/bluenviron/mediamtx/blob/main/mediamtx.yml>. ''; @@ -32,16 +32,16 @@ in env = lib.mkOption { type = with lib.types; attrsOf anything; - description = lib.mdDoc "Extra environment variables for MediaMTX"; + description = "Extra environment variables for MediaMTX"; default = {}; example = { MTX_CONFKEY = "mykey"; }; }; - allowVideoAccess = lib.mkEnableOption (lib.mdDoc '' + allowVideoAccess = lib.mkEnableOption '' access to video devices like cameras on the system - ''); + ''; }; }; diff --git a/nixos/modules/services/video/mirakurun.nix b/nixos/modules/services/video/mirakurun.nix index 208b34ab353a..bdd30805dbe8 100644 --- a/nixos/modules/services/video/mirakurun.nix +++ b/nixos/modules/services/video/mirakurun.nix @@ -24,12 +24,12 @@ in { options = { services.mirakurun = { - enable = mkEnableOption (lib.mdDoc "the Mirakurun DVR Tuner Server"); + enable = mkEnableOption "the Mirakurun DVR Tuner Server"; port = mkOption { type = with types; nullOr port; default = 40772; - description = lib.mdDoc '' + description = '' Port to listen on. If `null`, it won't listen on any port. ''; @@ -38,7 +38,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Open ports in the firewall for Mirakurun. ::: {.warning} @@ -52,7 +52,7 @@ in unixSocket = mkOption { type = with types; nullOr path; default = "/var/run/mirakurun/mirakurun.sock"; - description = lib.mdDoc '' + description = '' Path to unix socket to listen on. If `null`, it won't listen on any unix sockets. ''; @@ -61,7 +61,7 @@ in allowSmartCardAccess = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Install polkit rules to allow Mirakurun to access smart card readers which is commonly used along with tuner devices. ''; @@ -76,7 +76,7 @@ in overflowTimeLimit = 30000; }; ''; - description = lib.mdDoc '' + description = '' Options for server.yml. Documentation: @@ -96,7 +96,7 @@ in } ]; ''; - description = lib.mdDoc '' + description = '' Options which are added to tuners.yml. If none is specified, it will automatically be generated at runtime. @@ -117,7 +117,7 @@ in } ]; ''; - description = lib.mdDoc '' + description = '' Options which are added to channels.yml. If none is specified, it will automatically be generated at runtime. diff --git a/nixos/modules/services/video/photonvision.nix b/nixos/modules/services/video/photonvision.nix index fdbe9da3999d..d4568258db7d 100644 --- a/nixos/modules/services/video/photonvision.nix +++ b/nixos/modules/services/video/photonvision.nix @@ -6,12 +6,12 @@ in { options = { services.photonvision = { - enable = lib.mkEnableOption (lib.mdDoc "Enable PhotonVision"); + enable = lib.mkEnableOption "Enable PhotonVision"; package = lib.mkPackageOption pkgs "photonvision" {}; openFirewall = lib.mkOption { - description = lib.mdDoc '' + description = '' Whether to open the required ports in the firewall. ''; default = false; diff --git a/nixos/modules/services/video/replay-sorcery.nix b/nixos/modules/services/video/replay-sorcery.nix index 1be02f4d6da5..abe7202a4a86 100644 --- a/nixos/modules/services/video/replay-sorcery.nix +++ b/nixos/modules/services/video/replay-sorcery.nix @@ -9,23 +9,23 @@ in { options = with types; { services.replay-sorcery = { - enable = mkEnableOption (lib.mdDoc "the ReplaySorcery service for instant-replays"); + enable = mkEnableOption "the ReplaySorcery service for instant-replays"; - enableSysAdminCapability = mkEnableOption (lib.mdDoc '' + enableSysAdminCapability = mkEnableOption '' the system admin capability to support hardware accelerated video capture. This is equivalent to running ReplaySorcery as - root, so use with caution''); + root, so use with caution''; autoStart = mkOption { type = bool; default = false; - description = lib.mdDoc "Automatically start ReplaySorcery when graphical-session.target starts."; + description = "Automatically start ReplaySorcery when graphical-session.target starts."; }; settings = mkOption { type = attrsOf (oneOf [ str int ]); default = {}; - description = lib.mdDoc "System-wide configuration for ReplaySorcery (/etc/replay-sorcery.conf)."; + description = "System-wide configuration for ReplaySorcery (/etc/replay-sorcery.conf)."; example = literalExpression '' { videoInput = "hwaccel"; # requires `services.replay-sorcery.enableSysAdminCapability = true` diff --git a/nixos/modules/services/video/unifi-video.nix b/nixos/modules/services/video/unifi-video.nix index 1eb29fb0fd84..99c04bafd141 100644 --- a/nixos/modules/services/video/unifi-video.nix +++ b/nixos/modules/services/video/unifi-video.nix @@ -98,7 +98,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether or not to enable the unifi-video service. ''; }; @@ -114,7 +114,7 @@ in logDir = mkOption { type = types.str; default = "${stateDir}/logs"; - description = lib.mdDoc '' + description = '' Where to store the logs. ''; }; @@ -122,7 +122,7 @@ in dataDir = mkOption { type = types.str; default = "${stateDir}/data"; - description = lib.mdDoc '' + description = '' Where to store the database and other data. ''; }; @@ -130,7 +130,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether or not to open the required ports on the firewall. ''; }; @@ -139,7 +139,7 @@ in type = types.nullOr types.int; default = 1024; example = 4096; - description = lib.mdDoc '' + description = '' Set the maximum heap size for the JVM in MB. ''; }; @@ -148,7 +148,7 @@ in type = types.path; default = "${cfg.dataDir}/unifi-video.pid"; defaultText = literalExpression ''"''${config.${opt.dataDir}}/unifi-video.pid"''; - description = lib.mdDoc "Location of unifi-video pid file."; + description = "Location of unifi-video pid file."; }; }; diff --git a/nixos/modules/services/video/v4l2-relayd.nix b/nixos/modules/services/video/v4l2-relayd.nix index 2a9dbe00158f..7d1d712fa4a3 100644 --- a/nixos/modules/services/video/v4l2-relayd.nix +++ b/nixos/modules/services/video/v4l2-relayd.nix @@ -18,19 +18,19 @@ let instanceOpts = { name, ... }: { options = { - enable = mkEnableOption (lib.mdDoc "this v4l2-relayd instance"); + enable = mkEnableOption "this v4l2-relayd instance"; name = mkOption { type = types.str; default = name; - description = lib.mdDoc '' + description = '' The name of the instance. ''; }; cardLabel = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The name the camera will show up as. ''; }; @@ -38,7 +38,7 @@ let extraPackages = mkOption { type = with types; listOf package; default = [ ]; - description = lib.mdDoc '' + description = '' Extra packages to add to {env}`GST_PLUGIN_PATH` for the instance. ''; }; @@ -46,7 +46,7 @@ let input = { pipeline = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The gstreamer-pipeline to use for the input-stream. ''; }; @@ -54,7 +54,7 @@ let format = mkOption { type = types.str; default = "YUY2"; - description = lib.mdDoc '' + description = '' The video-format to read from input-stream. ''; }; @@ -62,7 +62,7 @@ let width = mkOption { type = types.ints.positive; default = 1280; - description = lib.mdDoc '' + description = '' The width to read from input-stream. ''; }; @@ -70,7 +70,7 @@ let height = mkOption { type = types.ints.positive; default = 720; - description = lib.mdDoc '' + description = '' The height to read from input-stream. ''; }; @@ -78,7 +78,7 @@ let framerate = mkOption { type = types.ints.positive; default = 30; - description = lib.mdDoc '' + description = '' The framerate to read from input-stream. ''; }; @@ -88,7 +88,7 @@ let format = mkOption { type = types.str; default = "YUY2"; - description = lib.mdDoc '' + description = '' The video-format to write to output-stream. ''; }; @@ -113,7 +113,7 @@ in }; } ''; - description = lib.mdDoc '' + description = '' v4l2-relayd instances to be created. ''; }; |