about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMatthieu Coudron <886074+teto@users.noreply.github.com>2024-03-06 23:32:41 +0100
committerMatthieu Coudron <886074+teto@users.noreply.github.com>2024-03-16 14:37:10 +0100
commit545c14d5e4d65d8ac8aa282bf5720e83695cd1f8 (patch)
treec9dcecabfcdc0136bf340901eb446f1dabc9cdd4 /doc
parent0c9417100fb3172cfa874f0d8641471d91a94c76 (diff)
doc/lua: mention the patching of interpreters
explain why they are patched in nixpkgs.
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/lua.section.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/languages-frameworks/lua.section.md b/doc/languages-frameworks/lua.section.md
index a6577a56a436c..87cd0c4c90d7b 100644
--- a/doc/languages-frameworks/lua.section.md
+++ b/doc/languages-frameworks/lua.section.md
@@ -17,6 +17,9 @@ The main package set contains aliases to these package sets, e.g.
 `luaPackages` refers to `lua5_1.pkgs` and `lua52Packages` to
 `lua5_2.pkgs`.
 
+Note that nixpkgs patches the non-luajit interpreters to avoid referring to
+`/usr` and have `;;` (a [placeholder](https://www.lua.org/manual/5.1/manual.html#pdf-package.path) replaced with the default LUA_PATH) work correctly.
+
 ### Installing Lua and packages {#installing-lua-and-packages}
 
 #### Lua environment defined in separate `.nix` file {#lua-environment-defined-in-separate-.nix-file}