Add OS/CPU/CC compatibility matrix to docs. Fix spelling.

author: Mike Pall <mike> 2010-03-07 17:12:21 +0100
committer: Mike Pall <mike> 2010-03-07 17:12:21 +0100
commit: 9fd1c6c586df3feeed67eb919d4cf06def46fced (patch)
tree: 423bd01aefd273595ef467f275bddbba870f848f /doc
parent: 6769397d381ffb41ff27ea09bf8d1321d829c13d (diff)
download: luajit-9fd1c6c586df3feeed67eb919d4cf06def46fced.tar.gz
luajit-9fd1c6c586df3feeed67eb919d4cf06def46fced.tar.bz2
luajit-9fd1c6c586df3feeed67eb919d4cf06def46fced.zip
4 files changed, 59 insertions, 10 deletions
diff --git a/doc/api.html b/doc/api.html
index 2d596677..5a57e276 100644
--- a/doc/api.html
+++ b/doc/api.html
@@ -122,8 +122,8 @@ argument.
 </p>
 <p>
 If the second argument is <tt>true</tt>, JIT compilation is also
-enabled, disabled or flushed recursively for all subfunctions of a
+enabled, disabled or flushed recursively for all sub-functions of a
-function. With <tt>false</tt> only the subfunctions are affected.
+function. With <tt>false</tt> only the sub-functions are affected.
 </p>
 <p>
 The <tt>jit.on</tt> and <tt>jit.off</tt> functions only set a flag
@@ -252,8 +252,8 @@ This sets the mode for the function at the stack index <tt>idx</tt> or
 the parent of the calling function (<tt>idx = 0</tt>). It either
 enables JIT compilation for a function, disables it and flushes any
 already compiled code or only flushes already compiled code. This
-applies recursively to all subfunctions of the function with
+applies recursively to all sub-functions of the function with
-<tt>LUAJIT_MODE_ALLFUNC</tt> or only to the subfunctions with
+<tt>LUAJIT_MODE_ALLFUNC</tt> or only to the sub-functions with
 <tt>LUAJIT_MODE_ALLSUBFUNC</tt>.
 </p>
diff --git a/doc/changes.html b/doc/changes.html
index c733e5d1..4f3a489c 100644
--- a/doc/changes.html
+++ b/doc/changes.html
@@ -299,7 +299,7 @@ This release is in sync with Coco 1.1.0 (see the
 <li>Unified closure checks in <tt>jit.*</tt>.</li>
 <li>Fixed some range checks in <tt>jit.util.*</tt>.</li>
 <li>Fixed __newindex call originating from <tt>jit_settable_str()</tt>.</li>
-<li>Merged with Lua 5.1 alpha (including early bugfixes).</li>
+<li>Merged with Lua 5.1 alpha (including early bug fixes).</li>
 </ul>
 <p>
 This is the first public release of LuaJIT.
diff --git a/doc/install.html b/doc/install.html
index 727668cf..ae50ee8d 100644
--- a/doc/install.html
+++ b/doc/install.html
@@ -8,6 +8,22 @@
 <meta name="Language" content="en">
 <link rel="stylesheet" type="text/css" href="bluequad.css" media="screen">
 <link rel="stylesheet" type="text/css" href="bluequad-print.css" media="print">
+<style type="text/css">
+table.compat {
+  line-height: 1.2;
+  width: 35em;
+}
+tr.compathead td {
+  font-weight: bold;
+}
+td.compatos {
+  width: 40%;
+}
+td.compatcc {
+  width: 30%;
+  vertical-align: top;
+}
+</style>
 </head>
 <body>
 <div id="site">
@@ -50,9 +66,37 @@ For the impatient (on POSIX systems):
 make &amp;&amp; sudo make install
 </pre>
 <p>
-LuaJIT currently builds out-of-the box on all popular x86 or x64 systems
+LuaJIT currently builds out-of-the box on most x86 or x64 systems.
-(Linux, Windows, OSX etc.).
+Here's the compatibility matrix for the supported combinations of
-</p>
+operating system, CPU and compilers:
+</p>
+<table class="compat">
+<tr class="compathead">
+<td class="compatos">Operating system</td>
+<td class="compatcc">x86 (32 bit)</td>
+<td class="compatcc">x64 (64 bit)</td>
+</tr>
+<tr class="odd separate">
+<td class="compatos">Linux</td>
+<td class="compatcc">GCC 4.x<br>GCC 3.4</td>
+<td class="compatcc">GCC 4.x</td>
+</tr>
+<tr class="even">
+<td class="compatos">Windows 98/XP/Vista/7</td>
+<td class="compatcc">MSVC (EE)<br>Windows SDK<br>MinGW (GCC)<br>Cygwin (GCC)</td>
+<td class="compatcc">MSVC<br>Windows SDK</td>
+</tr>
+<tr class="odd">
+<td class="compatos">OSX 10.3-10.6</td>
+<td class="compatcc">GCC 4.x<br>GCC 3.4</td>
+<td class="compatcc">GCC 4.x</td>
+</tr>
+<tr class="even">
+<td class="compatos">*BSD, other</td>
+<td class="compatcc">GCC 4.x<br>GCC 3.4</td>
+<td class="compatcc">(not supported)</td>
+</tr>
+</table>
 <h2>Configuring LuaJIT</h2>
 <p>
@@ -244,7 +288,7 @@ check the comments in <tt>src/Makefile</tt>. Here are some popular examples:
 </p>
 <p>
 You can cross-compile to a 32 bit binary on a multilib x64 OS by
-installing the multilib development pacakges (e.g. <tt>libc6-dev-i386</tt>
+installing the multilib development packages (e.g. <tt>libc6-dev-i386</tt>
 on Debian/Ubuntu) and running:
 </p>
 <pre class="code">
@@ -283,6 +327,11 @@ library is loaded or the JIT compiler will not be activated.</li>
 <pre class="code">
 -pagezero_size 10000 -image_base 100000000
 </pre>
+<p>
+It's recommended to <tt>rebase</tt> all (self-compiled) shared libraries
+which are loaded at runtime on OSX/x64 (e.g. C extension modules for Lua).
+See: <tt>man rebase</tt>
+</p>
 <br class="flush">
 </div>
 <div id="foot">
diff --git a/doc/running.html b/doc/running.html
index bc09d9e5..bec93f1f 100644
--- a/doc/running.html
+++ b/doc/running.html
@@ -129,7 +129,7 @@ systems.
 <p>
 This options allows fine-tuned control of the optimizations used by
 the JIT compiler. This is mainly intended for debugging LuaJIT itself.
-Please note that the JIT compiler is extremly fast (we are talking
+Please note that the JIT compiler is extremely fast (we are talking
 about the microsecond to millisecond range). Disabling optimizations
 doesn't have any visible impact on its overhead, but usually generates
 code that runs slower.
author	Mike Pall <mike>	2010-03-07 17:12:21 +0100
committer	Mike Pall <mike>	2010-03-07 17:12:21 +0100
commit	9fd1c6c586df3feeed67eb919d4cf06def46fced (patch)
tree	423bd01aefd273595ef467f275bddbba870f848f /doc
parent	6769397d381ffb41ff27ea09bf8d1321d829c13d (diff)
download	luajit-9fd1c6c586df3feeed67eb919d4cf06def46fced.tar.gz luajit-9fd1c6c586df3feeed67eb919d4cf06def46fced.tar.bz2 luajit-9fd1c6c586df3feeed67eb919d4cf06def46fced.zip