tbx_package

Arguments

tbx_path

a single string: absolute or relative path to the toolbox root directory.

Default path is the current working directory.

build_id

a single string: identifier of a specific build.

Default id is not set.

customize(workdir)

function: do some actions before the packing. workdir is a path to the toolbox root directory.

If unspecified, source files will be removed and everything else included.

package_file

a single string: the generated file name.

listing

string vector: files that have been compressed into the package file.

Description

tbx_package(…) create a single compressed file of a toolbox hierarchy. The toolbox hierarchy should contains binary artifacts produced by tbx_make. The resulting file can be installed locally using atomsInstall or uploaded to ATOMS web portal for sharing it.

The toolbox name (id) and version are read from the DESCRIPTION file. This file is mandatory in the toolbox.

tbx_package(tbx_path) create the toolbox whose root's directory is tbx_path. tbx_package() is equivalent to tbx_package(".").

tbx_package(tbx_path, build_id) create the toolbox and flag it with a specific build_id.

The resulting package_file is a file in the current directory named after the toolbox name (id), version and build_id if provided. It has also a platform specific flag if a native file is detected.

The package_file is a binary toolbox; it contains all files needed for the toolbox to be loaded in Scilab. It does not contains sources files nor auxiliary scripts used to build the toolbox.

The customize(workdir) can be used to remove extra files that you don't want to include. Lambda functions can be used to filter directories, add or remove files with specific patterns or extensions, copy extra files, etc...

Examples

cd SCI/contrib/toolbox_skeleton
tbx_make
tbx_package

See Also

• tbx_make — Builds fully or some given sections of a toolbox having a standard structure
• tbx_builder_macros — Creates the library(es) of a toolbox for its functions in Scilab language
• tbx_builder_src — Builds the user source code (non-gateway) in src/ subdirectory.
• tbx_builder_gateway — Builds the user gateway code in sci_gateway/ subdirectory.