186526
/
openresty
mirror of https://github.com/openresty/openresty.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: updated LuaJIT's docs to the latest version for the restydoc indexes.

This commit is contained in:
Yichun Zhang (agentzh) 2017-04-08 15:04:55 -07:00
parent df41967474
commit ba6621b12b
14 changed files with 81 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/LuaJIT-2.1/README.pod
View File

@ -65,7 +65,7 @@ programming language. Lua is a powerful, dynamic and light-weight
programming language. It may be embedded or used as a general-purpose,
stand-alone language.
LuaJIT is Copyright E<copy> 2005-2016 Mike Pall, released under the
LuaJIT is Copyright E<copy> 2005-2017 Mike Pall, released under the
E<rchevron> MIT open source license.
=head2 Compatibility
@ -189,13 +189,13 @@ LuaJIT.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file luajit.html
# 8082 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>

12
doc/LuaJIT-2.1/contact.pod
View File

@ -60,24 +60,28 @@ LuaJIT
=back
If you want to report bugs, propose fixes or suggest enhancements,
please use the GitHub issue tracker.
Please send general questions to the E<rchevron> LuaJIT mailing list.
You can also send any questions you have directly to me:
Contact info in image
=head2 Copyright
All documentation is Copyright E<copy> 2005-2016 Mike Pall.
All documentation is Copyright E<copy> 2005-2017 Mike Pall.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file contact.html
# 2813 bytes of input
#Wed Jun 29 13:18:14 2016 agentzh
# 2989 bytes of input
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>

4
doc/LuaJIT-2.1/ext_c_api.pod
View File

@ -163,14 +163,14 @@ note that this mechanism is not without overhead.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file ext_c_api.html
# 6042 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>
# Deleting phrasal "code" element (`tt_18) because it has super-phrasal elements (`br_3) as children.

4
doc/LuaJIT-2.1/ext_ffi.pod
View File

@ -273,13 +273,13 @@ undue conversion penalties.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file ext_ffi.html
# 10336 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>

4
doc/LuaJIT-2.1/ext_ffi_api.pod
View File

@ -488,14 +488,14 @@ itself still refers to a variable named C<i>.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file ext_ffi_api.html
# 21471 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>
# Deleting phrasal "code" element (`tt_157) because it has super-phrasal elements (`br_3, `br_4) as children.

4
doc/LuaJIT-2.1/ext_ffi_semantics.pod
View File

@ -1375,13 +1375,13 @@ called via the FFI, if the call is compiled.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file ext_ffi_semantics.html
# 53847 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>

4
doc/LuaJIT-2.1/ext_ffi_tutorial.pod
View File

@ -609,14 +609,14 @@ function scope is unnecessary.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file ext_ffi_tutorial.html
# 22557 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>
# Deleting phrasal "code" element (`tt_100) because it has super-phrasal elements (`br_33, `br_34) as children.

4
doc/LuaJIT-2.1/ext_jit.pod
View File

@ -168,14 +168,14 @@ know more.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file ext_jit.html
# 5903 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>
# Deleting phrasal "code" element (`tt_6) because it has super-phrasal elements (`br_2, `br_3) as children.

4
doc/LuaJIT-2.1/ext_profiler.pod
View File

@ -346,13 +346,13 @@ content immediately or copy it for later use.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file ext_profiler.html
# 13135 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>

29
doc/LuaJIT-2.1/extensions.pod
View File

@ -166,7 +166,8 @@ and cannot be loaded.
Note: C<LJ_GC64> mode requires a different frame layout, which implies
a different, incompatible bytecode format for ports that use this mode
(e.g. ARM64). This may be rectified in the future.
(e.g. ARM64 or MIPS64) or when explicitly enabled for x64. This may be
rectified in the future.
=head2 C<table.new(narray, nhash)> allocates a pre-sized table
@ -275,6 +276,12 @@ functions.
=item * C<debug.upvalueid()> and C<debug.upvaluejoin()>.
=item * Lua/C API extensions: C<lua_upvalueid()> C<lua_upvaluejoin()>
C<lua_loadx()> C<luaL_fileresult()> C<luaL_execresult()>
C<luaL_loadfilex()> C<luaL_loadbufferx()> C<luaL_traceback()>
C<luaL_setfuncs()> C<luaL_pushmodule()> C<luaL_newlibtable()>
C<luaL_newlib()>
=item * Command line option C<-E>.
=item * Command line checks C<__tostring> for errors.
@ -314,6 +321,10 @@ status.
=item * Remove C<math.mod()>, C<string.gfind()>.
=item * C<package.searchers>.
=item * C<module()> returns the module table.
=back
Note: this provides only partial compatibility with Lua 5.2 at the
@ -330,6 +341,16 @@ LuaJIT supports some extensions from Lua 5.3:
=item * Unicode escape C<'\u{XX...}'> embeds the UTF-8 encoding in
string literals.
=item * The argument table C<arg> can be read (and modified) by
C<LUA_INIT> and C<-e> chunks.
=item * C<io.read()> and C<file:read()> accept formats with or without
a leading C<*>.
=item * C<table.move(a1, f, e, t [,a2])>.
=item * C<coroutine.isyieldable()>.
=back
=head2 C++ Exception Interoperability
@ -441,13 +462,13 @@ destructors.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file extensions.html
# 16722 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
# 17525 bytes of input
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>

4
doc/LuaJIT-2.1/faq.pod
View File

@ -212,13 +212,13 @@ development of certain features, if they are important to you.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file faq.html
# 7685 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>

26
doc/LuaJIT-2.1/install.pod
View File

@ -185,6 +185,11 @@ MSVC or WinSDK.
Please read the instructions given in these files, before changing any
settings.
LuaJIT on x64 currently uses 32 bit GC objects by default. C<LJ_GC64>
mode may be explicitly enabled: add C<XCFLAGS=-DLUAJIT_ENABLE_GC64> to
the make command or run C<msvcbuild gc64> for MSVC/WinSDK. Please check
the note about the bytecode format differences, too.
=head2 POSIX Systems (Linux, OSX, *BSD etc.)
=head2 Prerequisites
@ -491,14 +496,15 @@ Apple, not me. Or use Android. :-p
ISDKP=$(xcrun --sdk iphoneos --show-sdk-path)
ICC=$(xcrun --sdk iphoneos --find clang)
ISDKF="-arch armv7 -isysroot $ISDKP"
make HOST_CC="clang -m32 -arch i386" CROSS="$(dirname $ICC)/" \
TARGET_FLAGS="$ISDKF" TARGET_SYS=iOS
make DEFAULT_CC=clang HOST_CC="clang -m32 -arch i386" \
CROSS="$(dirname $ICC)/" TARGET_FLAGS="$ISDKF" TARGET_SYS=iOS
# iOS/ARM64
ISDKP=$(xcrun --sdk iphoneos --show-sdk-path)
ICC=$(xcrun --sdk iphoneos --find clang)
ISDKF="-arch arm64 -isysroot $ISDKP"
make CROSS="$(dirname $ICC)/" TARGET_FLAGS="$ISDKF" TARGET_SYS=iOS
make DEFAULT_CC=clang CROSS="$(dirname $ICC)/" \
TARGET_FLAGS="$ISDKF" TARGET_SYS=iOS
=head2 Cross-compiling for consoles
@ -586,15 +592,11 @@ don't intend to load Lua/C modules at runtime.
=back
=item * If you're building a 64 bit application on OSX which links
directly or indirectly against LuaJIT, you need to link your main
executable with these flags:
directly or indirectly against LuaJIT which is not built for C<LJ_GC64>
mode, you need to link your main executable with these flags:
-pagezero_size 10000 -image_base 100000000
Also, it's recommended to C<rebase> all (self-compiled) shared
libraries which are loaded at runtime on OSX/x64 (e.g. C extension
modules for Lua). See: C<man rebase>
=back
Additional hints for initializing LuaJIT using the C API functions:
@ -683,14 +685,14 @@ package maintainer), anyway.
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file install.html
# 25008 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
# 25250 bytes of input
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>
# Deleting phrasal "a" element (`a_34) because it has super-phrasal elements (`br_16) as children.

4
doc/LuaJIT-2.1/running.pod
View File

@ -409,13 +409,13 @@ Max. total size of all machine code areas in KBytes
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file running.html
# 13720 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>

16
doc/LuaJIT-2.1/status.pod
View File

@ -87,17 +87,27 @@ are not handled correctly. The error may fall through an on-trace
C<pcall> or it may be passed on to the function set with C<lua_atpanic>
on x64. This issue will be fixed with the new garbage collector.
=item * LuaJIT on 64 bit systems provides a B<limited range> of 47 bits
for the B<legacy C<lightuserdata>> data type. This is only relevant on
x64 systems which use the negative part of the virtual address space in
user mode, e.g. Solaris/x64, and on ARM64 systems configured with a 48
bit or 52 bit VA. Avoid using C<lightuserdata> to hold pointers that
may point outside of that range, e.g. variables on the stack. In
general, avoid this data type for new code and replace it with (much
more performant) FFI bindings. FFI cdata pointers can address the full
64 bit range.
=back
----
Copyright E<copy> 2005-2016 Mike Pall E<middot> Contact
Copyright E<copy> 2005-2017 Mike Pall E<middot> Contact
=cut
#Pod::HTML2Pod conversion notes:
#From file status.html
# 3334 bytes of input
#Wed Jun 29 13:18:15 2016 agentzh
# 3931 bytes of input
#Sat Apr 8 14:31:44 2017 agentzh
# No a_name switch not specified, so will not try to render <a name='...'>
# No a_href switch not specified, so will not try to render <a href='...'>