From 1fa6c091c0e0e746df0c0e9de2350d7a5cf40276 Mon Sep 17 00:00:00 2001 From: Gabriel Fontes Date: Thu, 26 Dec 2024 16:06:26 -0300 Subject: [PATCH] docs: improve `files` option description --- modules/minecraft-servers.nix | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/modules/minecraft-servers.nix b/modules/minecraft-servers.nix index 0eb23aae..d6ae128e 100644 --- a/modules/minecraft-servers.nix +++ b/modules/minecraft-servers.nix @@ -482,9 +482,15 @@ in arbitrary files in the server's data directory. ''; files = with types; mkOpt' (attrsOf (either path configType)) { } '' - Things to copy into this server's data directory. Similar to - symlinks, but these are actual files. Useful for configuration - files that don't behave well when read-only. + Things to copy into this server's data directory. Similar to symlinks, + but these are actual, writable, files. Useful for configuration files + that don't behave well when read-only. Directories are copied recursively and + dereferenced. They will be deleted after the server stops, so any modification + is discarded. + + These files may include placeholders to substitute with values from + + (i.e. @variable_name@). ''; managementSystem = mkOption {