Module luarocks.build
Module implementing the LuaRocks "build" command.
Builds a rock, compiling its C parts if any.
Functions
| apply_patches (rockspec) | Applies patches inlined in the build.patches section and extracts files inlined in the build.extra_files section of a rockspec. |
| build_rockspec (rockspec_file, need_to_fetch, minimal_mode) | Build and install a rock given a rockspec. |
| build_rock (rock_file, need_to_fetch) | Build and install a rock. |
| run (name, version, ...) | Driver function for "build" command. |
Functions
- apply_patches (rockspec)
-
Applies patches inlined in the build.patches section
and extracts files inlined in the build.extra_files section
of a rockspec.
Parameters:
rockspec: table: A rockspec table.
Returns:
-
boolean or (nil, string): True if succeeded or
nil and an error message.
- build_rockspec (rockspec_file, need_to_fetch, minimal_mode)
-
Build and install a rock given a rockspec.
Parameters:
rockspec_file: string: local or remote filename of a rockspec.need_to_fetch: boolean: true if sources need to be fetched, false if the rockspec was obtained from inside a source rock.minimal_mode:
Returns:
-
boolean or (nil, string, [string]): True if succeeded or
nil and an error message followed by an error code.
- build_rock (rock_file, need_to_fetch)
-
Build and install a rock.
Parameters:
rock_file: string: local or remote filename of a rock.need_to_fetch: boolean: true if sources need to be fetched, false if the rockspec was obtained from inside a source rock.
Returns:
-
boolean or (nil, string, [string]): True if build was successful,
or false and an error message and an optional error code.
- run (name, version, ...)
-
Driver function for "build" command.
Parameters:
name: string: A local or remote rockspec or rock file. If a package name is given, forwards the request to "search" and, if returned a result, installs the matching rock.version: string: When passing a package name, a version number may also be given....:
Returns:
-
boolean or (nil, string): True if build was successful; nil and an
error message otherwise.