sol2/docs/source/api/compatibility.rst

compatibility.hpp
=================
Lua 5.3/5.2 compatibility for Lua 5.1/LuaJIT
--------------------------------------------

This is a detail header used to maintain compatability with the 5.2 and 5.3 APIs. It contains code from the MIT-Licensed `Lua code`_ in some places and also from the `lua-compat`_ repository by KeplerProject.

It is not fully documented as this header's only purpose is for internal use to make sure Sol compiles across all platforms / distributions with no errors or missing Lua functionality. If you think there's some compatibility features we are missing or if you are running into redefinition errors, please make an `issue in the issue tracker`_.

If you have this already in your project or you have your own compatibility layer, then please ``#define SOL_NO_COMPAT 1`` before including ``sol.hpp`` or pass this flag on the command line to turn off the compatibility wrapper.

For the licenses, see :doc:`here<../licenses>`

.. _issue in the issue tracker: https://github.com/ThePhD/sol2/issues/
.. _Lua code: http://www.Lua.org/
.. _lua-compat: https://github.com/keplerproject/lua-compat-5.3
The docs are here. 2016-03-12 06:47:15 +08:00			`compatibility.hpp`
			`=================`
			`Lua 5.3/5.2 compatibility for Lua 5.1/LuaJIT`
			`--------------------------------------------`

fixing up da docs 2016-03-12 10:45:41 +08:00			This is a detail header used to maintain compatability with the 5.2 and 5.3 APIs. It contains code from the MIT-Licensed `Lua code`_ in some places and also from the `lua-compat`_ repository by KeplerProject.
The docs are here. 2016-03-12 06:47:15 +08:00
fixing up da docs 2016-03-12 10:45:41 +08:00			It is not fully documented as this header's only purpose is for internal use to make sure Sol compiles across all platforms / distributions with no errors or missing Lua functionality. If you think there's some compatibility features we are missing or if you are running into redefinition errors, please make an `issue in the issue tracker`_.
The docs are here. 2016-03-12 06:47:15 +08:00
Herpin' that derp. SOL_NO_COMPAT is now in the proper place and documented in the compatibility part of the API. Basic test for `table::add` 2016-06-20 07:02:40 +08:00			If you have this already in your project or you have your own compatibility layer, then please ``#define SOL_NO_COMPAT 1`` before including ``sol.hpp`` or pass this flag on the command line to turn off the compatibility wrapper.

fixing up da docs 2016-03-12 10:45:41 +08:00			For the licenses, see :doc:`here<../licenses>`

			`.. _issue in the issue tracker: https://github.com/ThePhD/sol2/issues/`
			`.. _Lua code: http://www.Lua.org/`
			`.. _lua-compat: https://github.com/keplerproject/lua-compat-5.3`