LUA-UTILS.ECLASS

Section: eclass-manpages (5)
Updated: Dec 2020
Index Return to Main Contents

NAME

lua-utils.eclass - Utility functions for packages with Lua parts

DESCRIPTION

A utility eclass providing functions to query Lua implementations, install Lua modules and scripts.

This eclass neither sets any metadata variables nor exports any phase functions. It can be inherited safely.

SUPPORTED EAPIS

7

FUNCTIONS

lua_get_CFLAGS [<impl>]
Obtain and print the compiler flags for building against Lua, for the given implementation. If no implementation is provided, ${ELUA} will be used.

Please note that this function requires Lua and pkg-config installed, and therefore proper build-time dependencies need be added to the ebuild.

lua_get_cmod_dir [<impl>]
Obtain and print the name of the directory into which compiled Lua modules are installed, for the given implementation. If no implementation is provided, ${ELUA} will be used.

Please note that this function requires Lua and pkg-config installed, and therefore proper build-time dependencies need be added to the ebuild.

lua_get_include_dir [<impl>]
Obtain and print the name of the directory containing header files of the given Lua implementation. If no implementation is provided, ${ELUA} will be used.

Please note that this function requires Lua and pkg-config installed, and therefore proper build-time dependencies need be added to the ebuild.

lua_get_LIBS [<impl>]
Obtain and print the compiler flags for linking against Lua, for the given implementation. If no implementation is provided, ${ELUA} will be used.

Please note that this function requires Lua and pkg-config installed, and therefore proper build-time dependencies need be added to the ebuild.

lua_get_lmod_dir [<impl>]
Obtain and print the name of the directory into which native-Lua modules are installed, for the given implementation. If no implementation is provided, ${ELUA} will be used.

Please note that this function requires Lua and pkg-config installed, and therefore proper build-time dependencies need be added to the ebuild.

lua_get_shared_lib [<impl>]
Obtain and print the expected name, with path, of the main shared library of the given Lua implementation. If no implementation is provided, ${ELUA} will be used.

Note that it is up to the ebuild maintainer to ensure Lua actually provides a shared library.

Please note that this function requires Lua and pkg-config installed, and therefore proper build-time dependencies need be added to the ebuild.

lua_get_version [<impl>]
Obtain and print the full version number of the given Lua implementation. If no implementation is provided, ${ELUA} will be used.

Please note that this function requires Lua and pkg-config installed, and therefore proper build-time dependencies need be added to the ebuild.

ECLASS VARIABLES

ELUA
The executable name of the current Lua interpreter. This variable is set automatically in functions called by lua_foreach_impl().

Example value:

lua5.1
LUA
The absolute path to the current Lua interpreter. This variable is set automatically in functions called by lua_foreach_impl().

Example value:

/usr/bin/lua5.1

AUTHORS

Marek Szuba <marecki@gentoo.org>
Based on python-utils-r1.eclass by Michał Górny <mgorny@gentoo.org> et al.

MAINTAINERS

William Hubbs <williamh@gentoo.org>
Marek Szuba <marecki@gentoo.org>

REPORTING BUGS

Please report bugs via https://bugs.gentoo.org/

FILES

lua-utils.eclass

SEE ALSO

ebuild(5)
https://gitweb.gentoo.org/repo/gentoo.git/log/eclass/lua-utils.eclass


Index

NAME
DESCRIPTION
SUPPORTED EAPIS
FUNCTIONS
ECLASS VARIABLES
AUTHORS
MAINTAINERS
REPORTING BUGS
FILES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 03:27:01 GMT, December 03, 2020