From ee855749a188d3d13bba9a0e58f430e138e641ae Mon Sep 17 00:00:00 2001 From: Mike Pall Date: Sat, 2 Jan 2021 21:17:01 +0100 Subject: Documentation cleanup. --- doc/install.html | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) (limited to 'doc/install.html') diff --git a/doc/install.html b/doc/install.html index 85ca9913..6110450c 100644 --- a/doc/install.html +++ b/doc/install.html @@ -101,8 +101,8 @@ operating systems, CPUs and compilers: CPU / OS Linux or
Android *BSD, Other -OSX 10.4+ or
iOS 3.0+ -Windows
XP/Vista/7 +macOS 10.4+ or
iOS 3.0+ +Windows XP
or later x86 (32 bit) @@ -168,7 +168,7 @@ Please read the instructions given in these files, before changing any settings.

-

POSIX Systems (Linux, OSX, *BSD etc.)

+

POSIX Systems (Linux, macOS, *BSD etc.)

Prerequisites

Depending on your distribution, you may need to install a package for @@ -176,8 +176,9 @@ GCC, the development headers and/or a complete SDK. E.g. on a current Debian/Ubuntu, install libc6-dev with the package manager.

-Download the current source package of LuaJIT (pick the .tar.gz), -if you haven't already done so. Move it to a directory of your choice, +The recommended way to fetch the latest version is to do a pull from +the git repository. Alternatively download the latest source package of +LuaJIT (pick the .tar.gz). Move it to a directory of your choice, open a terminal window and change to this directory. Now unpack the archive and change to the newly created directory:

@@ -207,7 +208,7 @@ You can add an extra prefix to the search paths by appending the make PREFIX=/home/myself/lj2

-Note for OSX: you must set the MACOSX_DEPLOYMENT_TARGET +Note for macOS: you must set the MACOSX_DEPLOYMENT_TARGET environment variable to a value supported by your toolchain.

Installing LuaJIT

@@ -241,8 +242,9 @@ GCC plus the required development headers. Or install Microsoft's Visual Studio (MSVC).

-Next, download the source package and unpack it using an archive manager -(e.g. the Windows Explorer) to a directory of your choice. +Next, pull from the git repository or download the source package and +unpack it using an archive manager (e.g. the Windows Explorer) to +a directory of your choice.

Building with MSVC

@@ -260,8 +262,8 @@ Then follow the installation instructions below.

Building with MinGW or Cygwin

Open a command prompt window and make sure the MinGW or Cygwin programs -are in your path. Then cd to the directory where -you've unpacked the sources and run this command for MinGW: +are in your path. Then cd to the directory of the git repository +or where you've unpacked the sources. Then run this command for MinGW: 

 mingw32-make
@@ -302,7 +304,7 @@ x64 OS, you need to install the multilib development package (e.g.
 

 You need to specify TARGET_SYS whenever the host OS and the
 target OS differ, or you'll get assembler or linker errors. E.g. if
-you're compiling on a Windows or OSX host for embedded Linux or Android,
+you're compiling on a Windows or macOS host for embedded Linux or Android,
 you need to add TARGET_SYS=Linux to the examples below. For a
 minimal target OS, you may need to disable the built-in allocator in
 src/Makefile and use TARGET_SYS=Other. Don't forget to
@@ -461,15 +463,14 @@ intend to load Lua/C modules at runtime.
 
 
 
  • 
-If you're building a 64 bit application on OSX which links directly or
+Important: this relates to LuaJIT 2.0 only — use LuaJIT 2.1 to
+avoid these complications.
    
+If you're building a 64 bit application on macOS which links directly or
 indirectly against LuaJIT, you need to link your main executable
 with these flags:
 
     -pagezero_size 10000 -image_base 100000000
 
    
-Also, it's recommended to rebase all (self-compiled) shared libraries
-which are loaded at runtime on OSX/x64 (e.g. C extension modules for Lua).
-See: man rebase
 
    • 
 
 
    Additional hints for initializing LuaJIT using the C API functions:
    
@@ -479,7 +480,7 @@ See: man rebase
 for embedding Lua or LuaJIT into your application.
 
  • Make sure you use luaL_newstate. Avoid using
 lua_newstate, since this uses the (slower) default memory
-allocator from your system (no support for this on x64).
    • 
+allocator from your system (no support for this on 64 bit architectures).
 
  • Make sure you use luaL_openlibs and not the old Lua 5.0 style
 of calling luaopen_base etc. directly.
    • 
 
  • To change or extend the list of standard libraries to load, copy
-- 
cgit v1.2.3-55-g6feb