about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorAtemu <atemu.main@gmail.com>2023-05-21 12:48:58 +0200
committerAnderson Torres <torres.anderson.85@protonmail.com>2023-05-22 11:34:04 -0300
commit8912c50fc7c9241fd49e61c2387eb0126a49a679 (patch)
tree06f8f0be0a31d98ec9a59d3bad1dc6f28f3e477f /doc
parentd5f0da152a8245169e85823f67543e1851c82490 (diff)
doc:fhs-envs: mention that runScript must be escaped by the caller
Diffstat (limited to 'doc')
-rw-r--r--doc/builders/special/fhs-environments.section.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/builders/special/fhs-environments.section.md b/doc/builders/special/fhs-environments.section.md
index 0adacb59cfd43..13d744ab75498 100644
--- a/doc/builders/special/fhs-environments.section.md
+++ b/doc/builders/special/fhs-environments.section.md
@@ -17,7 +17,8 @@
 - `extraInstallCommands`
         Additional commands to be executed for finalizing the derivation with runner script.
 - `runScript`
-        A command that would be executed inside the sandbox and passed all the command line arguments. It defaults to `bash`.
+        A shell command to be executed inside the sandbox. It defaults to `bash`. Command line arguments passed to the resulting wrapper are appended to this command by default.
+        This command must be escaped; i.e. `"foo app" --do-stuff --with "some file"`. See `lib.escapeShellArgs`.
 - `profile`
         Optional script for `/etc/profile` within the sandbox.