aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2011-12-15 11:16:50 -0500
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2011-12-15 11:16:50 -0500
commit83eabf083b695a296556b35b30be052afd76ee0c (patch)
tree7bee81144b0cd57d96496a50e55d13cc5114ebd7 /doc
parent4379015de5be80ac8a4ec280390960fe7f249c11 (diff)
Add support for compiling with LuaJIT.
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/12_Compiling.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/manual/12_Compiling.md b/doc/manual/12_Compiling.md
index cf1e83c5..3a8b5043 100644
--- a/doc/manual/12_Compiling.md
+++ b/doc/manual/12_Compiling.md
@@ -79,3 +79,21 @@ lines (put `//` at the start of the line):
#define CharacterRange Sci_CharacterRange
#define TextRange Sci_TextRange
#define TextToFind Sci_TextToFind
+
+#### Compiling with LuaJIT
+
+[LuaJIT](http://luajit.org) is a Just-In-Time Compiler for Lua and can boost the
+speed of Lua programs. I have noticed that syntax highlighting can be up to 2
+times faster with LuaJIT than with vanilla Lua. This difference is largely
+unnoticable on modern computers and usually only discernable when initially
+loading large files. Other than syntax highlighting, LuaJIT offers no real
+benefit performance-wise to justify it being Textadept's default runtime.
+LuaJIT's [ffi library](http://luajit.org/ext_ffi.html), however, appears to be
+useful for interfacing with external, non-Lua, libraries.
+
+You can compile Textadept with LuaJIT by running `make LUAJIT=1` for non-Windows
+systems and `make WIN32=1 LUAJIT=1` for Windows systems.
+
+Please note that a `lua51.dll` is produced for Windows platforms because
+limitations on external Lua library loading do not allow statically linking
+LuaJIT to Textadept. Static linking occurs on all other platforms.