summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/games
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-08-28 21:18:44 +0200
committerpennae <github@quasiparticle.net>2022-08-31 16:32:53 +0200
commitef176dcf7e76c3639571d7c6051246c8fbadf12a (patch)
tree3bb88ef3515ace2ad477e245bf347213c6055464 /nixos/modules/services/games
parent5a643387ec1234c5f25357f2ff962a84895436f6 (diff)
nixos/*: automatically convert option descriptions
conversions were done using https://github.com/pennae/nix-doc-munge using (probably) rev f34e145 running nix-doc-munge nixos/**/*.nix nix-doc-munge --import nixos/**/*.nix the tool ensures that only changes that could affect the generated manual *but don't* are committed, other changes require manual review and are discarded.
Diffstat (limited to 'nixos/modules/services/games')
-rw-r--r--nixos/modules/services/games/asf.nix2
-rw-r--r--nixos/modules/services/games/factorio.nix2
-rw-r--r--nixos/modules/services/games/freeciv.nix12
-rw-r--r--nixos/modules/services/games/openarena.nix2
-rw-r--r--nixos/modules/services/games/quake3-server.nix2
-rw-r--r--nixos/modules/services/games/teeworlds.nix2
6 files changed, 11 insertions, 11 deletions
diff --git a/nixos/modules/services/games/asf.nix b/nixos/modules/services/games/asf.nix
index 592ab4bedcfe..10847e8f11f3 100644
--- a/nixos/modules/services/games/asf.nix
+++ b/nixos/modules/services/games/asf.nix
@@ -44,7 +44,7 @@ in
type = types.submodule {
options = {
enable = mkEnableOption
- "Wheter to start the web-ui. This is the preferred way of configuring things such as the steam guard token";
+ (lib.mdDoc "Wheter to start the web-ui. This is the preferred way of configuring things such as the steam guard token");
package = mkOption {
type = types.package;
diff --git a/nixos/modules/services/games/factorio.nix b/nixos/modules/services/games/factorio.nix
index 893afa97722e..f54c265c34b0 100644
--- a/nixos/modules/services/games/factorio.nix
+++ b/nixos/modules/services/games/factorio.nix
@@ -44,7 +44,7 @@ in
{
options = {
services.factorio = {
- enable = mkEnableOption name;
+ enable = mkEnableOption (lib.mdDoc name);
port = mkOption {
type = types.int;
default = 34197;
diff --git a/nixos/modules/services/games/freeciv.nix b/nixos/modules/services/games/freeciv.nix
index 02af9fda7afd..8b340bb161a5 100644
--- a/nixos/modules/services/games/freeciv.nix
+++ b/nixos/modules/services/games/freeciv.nix
@@ -25,7 +25,7 @@ in
{
options = {
services.freeciv = {
- enable = mkEnableOption ''freeciv'';
+ enable = mkEnableOption (lib.mdDoc ''freeciv'');
settings = mkOption {
description = lib.mdDoc ''
Parameters of freeciv-server.
@@ -38,7 +38,7 @@ in
default = "none";
description = lib.mdDoc "Announce game in LAN using given protocol.";
};
- options.auth = mkEnableOption "server authentication";
+ options.auth = mkEnableOption (lib.mdDoc "server authentication");
options.Database = mkOption {
type = types.nullOr types.str;
apply = pkgs.writeText "auth.conf";
@@ -54,9 +54,9 @@ in
default = 0;
description = lib.mdDoc "Set debug log level.";
};
- options.exit-on-end = mkEnableOption "exit instead of restarting when a game ends.";
- options.Guests = mkEnableOption "guests to login if auth is enabled";
- options.Newusers = mkEnableOption "new users to login if auth is enabled";
+ options.exit-on-end = mkEnableOption (lib.mdDoc "exit instead of restarting when a game ends.");
+ options.Guests = mkEnableOption (lib.mdDoc "guests to login if auth is enabled");
+ options.Newusers = mkEnableOption (lib.mdDoc "new users to login if auth is enabled");
options.port = mkOption {
type = types.port;
default = 5556;
@@ -86,7 +86,7 @@ in
};
};
};
- openFirewall = mkEnableOption "opening the firewall for the port listening for clients";
+ openFirewall = mkEnableOption (lib.mdDoc "opening the firewall for the port listening for clients");
};
};
config = mkIf cfg.enable {
diff --git a/nixos/modules/services/games/openarena.nix b/nixos/modules/services/games/openarena.nix
index e38bc8f205a1..89e30d7c12af 100644
--- a/nixos/modules/services/games/openarena.nix
+++ b/nixos/modules/services/games/openarena.nix
@@ -8,7 +8,7 @@ in
{
options = {
services.openarena = {
- enable = mkEnableOption "OpenArena";
+ enable = mkEnableOption (lib.mdDoc "OpenArena");
openPorts = mkOption {
type = types.bool;
diff --git a/nixos/modules/services/games/quake3-server.nix b/nixos/modules/services/games/quake3-server.nix
index ee1bb9aad47a..2d2148237da1 100644
--- a/nixos/modules/services/games/quake3-server.nix
+++ b/nixos/modules/services/games/quake3-server.nix
@@ -37,7 +37,7 @@ let
in {
options = {
services.quake3-server = {
- enable = mkEnableOption "Quake 3 dedicated server";
+ enable = mkEnableOption (lib.mdDoc "Quake 3 dedicated server");
port = mkOption {
type = types.port;
diff --git a/nixos/modules/services/games/teeworlds.nix b/nixos/modules/services/games/teeworlds.nix
index 6ddd0bee60cd..6c920a0df058 100644
--- a/nixos/modules/services/games/teeworlds.nix
+++ b/nixos/modules/services/games/teeworlds.nix
@@ -20,7 +20,7 @@ in
{
options = {
services.teeworlds = {
- enable = mkEnableOption "Teeworlds Server";
+ enable = mkEnableOption (lib.mdDoc "Teeworlds Server");
openPorts = mkOption {
type = types.bool;