about summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorRobert Hensing <roberth@users.noreply.github.com>2022-12-23 01:20:44 +0100
committerGitHub <noreply@github.com>2022-12-23 01:20:44 +0100
commit84c140962765ac2820d9f78e720f13ace5c40a96 (patch)
treec47f48b127fb6f8a6c8c9ff3822533b13c5e3f6e /nixos
parentf46ceb50abf8815429d56fc4f09c0af09c453ff5 (diff)
parentfeb9ba583931314ba4451bb0fa04a5cbe43aaaeb (diff)
Merge pull request #207268 from ncfavier/systemd-scriptArgs
nixos/systemd: document what `scriptArgs` is for
Diffstat (limited to 'nixos')
-rw-r--r--nixos/lib/systemd-unit-options.nix6
1 files changed, 5 insertions, 1 deletions
diff --git a/nixos/lib/systemd-unit-options.nix b/nixos/lib/systemd-unit-options.nix
index 44f26572a23ba..9c7cb34f14b57 100644
--- a/nixos/lib/systemd-unit-options.nix
+++ b/nixos/lib/systemd-unit-options.nix
@@ -324,7 +324,11 @@ in rec {
       scriptArgs = mkOption {
         type = types.str;
         default = "";
-        description = lib.mdDoc "Arguments passed to the main process script.";
+        example = "%i";
+        description = lib.mdDoc ''
+          Arguments passed to the main process script.
+          Can contain specifiers (`%` placeholders expanded by systemd, see {manpage}`systemd.unit(5)`).
+        '';
       };
 
       preStart = mkOption {