aboutsummaryrefslogtreecommitdiff
path: root/doc/install.html
diff options
context:
space:
mode:
authorMike Pall <mike>2021-01-02 21:32:09 +0100
committerMike Pall <mike>2021-01-02 21:32:09 +0100
commitebc3503813209e3f46606234b280ef8a7251993c (patch)
tree7bed137356b0ab510de75058fa46d1a952500162 /doc/install.html
parent65378759f38bb946e40f31799992434effd01bba (diff)
parentee855749a188d3d13bba9a0e58f430e138e641ae (diff)
downloadluajit-ebc3503813209e3f46606234b280ef8a7251993c.tar.gz
luajit-ebc3503813209e3f46606234b280ef8a7251993c.tar.bz2
luajit-ebc3503813209e3f46606234b280ef8a7251993c.zip
Merge branch 'master' into v2.1
Diffstat (limited to 'doc/install.html')
-rw-r--r--doc/install.html42
1 files changed, 18 insertions, 24 deletions
diff --git a/doc/install.html b/doc/install.html
index 451fdd41..07f0f8a3 100644
--- a/doc/install.html
+++ b/doc/install.html
@@ -103,8 +103,8 @@ operating systems, CPUs and compilers:
103<td class="compatcpu">CPU / OS</td> 103<td class="compatcpu">CPU / OS</td>
104<td class="compatos"><a href="#posix">Linux</a> or<br><a href="#android">Android</a></td> 104<td class="compatos"><a href="#posix">Linux</a> or<br><a href="#android">Android</a></td>
105<td class="compatos"><a href="#posix">*BSD, Other</a></td> 105<td class="compatos"><a href="#posix">*BSD, Other</a></td>
106<td class="compatos"><a href="#posix">OSX 10.4+</a> or<br><a href="#ios">iOS 3.0+</a></td> 106<td class="compatos"><a href="#posix">macOS 10.4+</a> or<br><a href="#ios">iOS 3.0+</a></td>
107<td class="compatos"><a href="#windows">Windows<br>XP/Vista/7</a></td> 107<td class="compatos"><a href="#windows">Windows 7<br>or later</a></td>
108</tr> 108</tr>
109<tr class="odd separate"> 109<tr class="odd separate">
110<td class="compatcpu">x86 (32 bit)</td> 110<td class="compatcpu">x86 (32 bit)</td>
@@ -128,7 +128,7 @@ operating systems, CPUs and compilers:
128<td class="compatos compatno">&nbsp;</td> 128<td class="compatos compatno">&nbsp;</td>
129</tr> 129</tr>
130<tr class="even"> 130<tr class="even">
131<td class="compatcpu"><a href="#cross2">ARM64</a></td> 131<td class="compatcpu"><a href="#cross2">ARM64<br>ARM64be</a></td>
132<td class="compatos">GCC 4.8+</td> 132<td class="compatos">GCC 4.8+</td>
133<td class="compatos compatno">&nbsp;</td> 133<td class="compatos compatno">&nbsp;</td>
134<td class="compatos">XCode 6.0+<br>Clang 3.5+</td> 134<td class="compatos">XCode 6.0+<br>Clang 3.5+</td>
@@ -142,7 +142,7 @@ operating systems, CPUs and compilers:
142<td class="compatos">XEDK (<a href="#xbox360">Xbox 360</a>)</td> 142<td class="compatos">XEDK (<a href="#xbox360">Xbox 360</a>)</td>
143</tr> 143</tr>
144<tr class="even"> 144<tr class="even">
145<td class="compatcpu"><a href="#cross2">MIPS32<br>MIPS64</a></td> 145<td class="compatcpu"><a href="#cross2">MIPS32<br>MIPS64<br>MIPS64r6</a></td>
146<td class="compatos">GCC 4.3+</td> 146<td class="compatos">GCC 4.3+</td>
147<td class="compatos">GCC 4.3+</td> 147<td class="compatos">GCC 4.3+</td>
148<td class="compatos compatno">&nbsp;</td> 148<td class="compatos compatno">&nbsp;</td>
@@ -177,7 +177,7 @@ Please check the note about the
177<a href="extensions.html#string_dump">bytecode format</a> differences, too. 177<a href="extensions.html#string_dump">bytecode format</a> differences, too.
178</p> 178</p>
179 179
180<h2 id="posix">POSIX Systems (Linux, OSX, *BSD etc.)</h2> 180<h2 id="posix">POSIX Systems (Linux, macOS, *BSD etc.)</h2>
181<h3>Prerequisites</h3> 181<h3>Prerequisites</h3>
182<p> 182<p>
183Depending on your distribution, you may need to install a package for 183Depending on your distribution, you may need to install a package for
@@ -185,14 +185,15 @@ GCC, the development headers and/or a complete SDK. E.g. on a current
185Debian/Ubuntu, install <tt>libc6-dev</tt> with the package manager. 185Debian/Ubuntu, install <tt>libc6-dev</tt> with the package manager.
186</p> 186</p>
187<p> 187<p>
188Download the current source package of LuaJIT (pick the .tar.gz), 188The recommended way to fetch the latest version is to do a pull from
189if you haven't already done so. Move it to a directory of your choice, 189the git repository. Alternatively download the latest source package of
190LuaJIT (pick the .tar.gz). Move it to a directory of your choice,
190open a terminal window and change to this directory. Now unpack the archive 191open a terminal window and change to this directory. Now unpack the archive
191and change to the newly created directory: 192and change to the newly created directory:
192</p> 193</p>
193<pre class="code"> 194<pre class="code">
194tar zxf LuaJIT-2.0.5.tar.gz 195tar zxf LuaJIT-2.1.0-beta3.tar.gz
195cd LuaJIT-2.0.5</pre> 196cd LuaJIT-2.1.0-beta3</pre>
196<h3>Building LuaJIT</h3> 197<h3>Building LuaJIT</h3>
197<p> 198<p>
198The supplied Makefiles try to auto-detect the settings needed for your 199The supplied Makefiles try to auto-detect the settings needed for your
@@ -216,7 +217,7 @@ You can add an extra prefix to the search paths by appending the
216make PREFIX=/home/myself/lj2 217make PREFIX=/home/myself/lj2
217</pre> 218</pre>
218<p> 219<p>
219Note for OSX: you must set the <tt>MACOSX_DEPLOYMENT_TARGET</tt> 220Note for macOS: you must set the <tt>MACOSX_DEPLOYMENT_TARGET</tt>
220environment variable to a value supported by your toolchain. 221environment variable to a value supported by your toolchain.
221</p> 222</p>
222<h3>Installing LuaJIT</h3> 223<h3>Installing LuaJIT</h3>
@@ -250,8 +251,9 @@ GCC plus the required development headers.
250Or install Microsoft's Visual Studio (MSVC). 251Or install Microsoft's Visual Studio (MSVC).
251</p> 252</p>
252<p> 253<p>
253Next, download the source package and unpack it using an archive manager 254Next, pull from the git repository or download the source package and
254(e.g. the Windows Explorer) to a directory of your choice. 255unpack it using an archive manager (e.g. the Windows Explorer) to
256a directory of your choice.
255</p> 257</p>
256<h3>Building with MSVC</h3> 258<h3>Building with MSVC</h3>
257<p> 259<p>
@@ -269,8 +271,8 @@ Then follow the installation instructions below.
269<h3>Building with MinGW or Cygwin</h3> 271<h3>Building with MinGW or Cygwin</h3>
270<p> 272<p>
271Open a command prompt window and make sure the MinGW or Cygwin programs 273Open a command prompt window and make sure the MinGW or Cygwin programs
272are in your path. Then <tt>cd</tt> to the directory where 274are in your path. Then <tt>cd</tt> to the directory of the git repository
273you've unpacked the sources and run this command for MinGW: 275or where you've unpacked the sources. Then run this command for MinGW:
274</p> 276</p>
275<pre class="code"> 277<pre class="code">
276mingw32-make 278mingw32-make
@@ -325,7 +327,7 @@ You need to specify <tt>TARGET_SYS</tt> whenever the host OS and the
325target OS differ, or you'll get assembler or linker errors: 327target OS differ, or you'll get assembler or linker errors:
326</p> 328</p>
327<ul> 329<ul>
328<li>E.g. if you're compiling on a Windows or OSX host for embedded Linux or Android, you need to add <tt>TARGET_SYS=Linux</tt> to the examples below.</li> 330<li>E.g. if you're compiling on a Windows or macOS host for embedded Linux or Android, you need to add <tt>TARGET_SYS=Linux</tt> to the examples below.</li>
329<li>For a minimal target OS, you may need to disable the built-in allocator in <tt>src/Makefile</tt> and use <tt>TARGET_SYS=Other</tt>.</li> 331<li>For a minimal target OS, you may need to disable the built-in allocator in <tt>src/Makefile</tt> and use <tt>TARGET_SYS=Other</tt>.</li>
330<li>Don't forget to specify the same <tt>TARGET_SYS</tt> for the install step, too.</li> 332<li>Don't forget to specify the same <tt>TARGET_SYS</tt> for the install step, too.</li>
331</ul> 333</ul>
@@ -522,14 +524,6 @@ the DLL). You may link LuaJIT statically on Windows only if you don't
522intend to load Lua/C modules at runtime. 524intend to load Lua/C modules at runtime.
523</li></ul> 525</li></ul>
524</li> 526</li>
525<li>
526If you're building a 64 bit application on OSX which links directly or
527indirectly against LuaJIT which is not built for <tt>LJ_GC64</tt> mode,
528you need to link your main executable with these flags:
529<pre class="code">
530-pagezero_size 10000 -image_base 100000000
531</pre>
532</li>
533</ul> 527</ul>
534<p>Additional hints for initializing LuaJIT using the C API functions:</p> 528<p>Additional hints for initializing LuaJIT using the C API functions:</p>
535<ul> 529<ul>
@@ -538,7 +532,7 @@ you need to link your main executable with these flags:
538for embedding Lua or LuaJIT into your application.</li> 532for embedding Lua or LuaJIT into your application.</li>
539<li>Make sure you use <tt>luaL_newstate</tt>. Avoid using 533<li>Make sure you use <tt>luaL_newstate</tt>. Avoid using
540<tt>lua_newstate</tt>, since this uses the (slower) default memory 534<tt>lua_newstate</tt>, since this uses the (slower) default memory
541allocator from your system (no support for this on x64).</li> 535allocator from your system (no support for this on 64&nbsp;bit architectures).</li>
542<li>Make sure you use <tt>luaL_openlibs</tt> and not the old Lua 5.0 style 536<li>Make sure you use <tt>luaL_openlibs</tt> and not the old Lua 5.0 style
543of calling <tt>luaopen_base</tt> etc. directly.</li> 537of calling <tt>luaopen_base</tt> etc. directly.</li>
544<li>To change or extend the list of standard libraries to load, copy 538<li>To change or extend the list of standard libraries to load, copy