spl-make-toolkit

The spl-make-toolkit command indexes a toolkit and makes the functions and operators it contains ready for use by SPL programs.

Usage

Figure 1. spl-make-toolkit

1? 
2.1 -c
2.1 --clean? 
2.1 -h
2.1 --help! 
2.1 -i
2.1 --directory
1 toolkit-directory? 
2.1 -m
2.1 --make-operator? 
2.1 -s
2.1 --silent? 
2.1 -r
2.1 --product-version
1 required-product-version?  --no-mixed-mode-processing?  --verbose-model-errors?  mixed-mode-arguments
spl-make-toolkit 
-h,--help |  -i, --directory <toolkit-dir> [-c, --clean] [-m, --make-operator] 
[-s, --silent] [-n, --name <name>] [-d, --description <description>] 
[-v, --version <version>] [-r, --product-version <required-product-version>]          
[--no-mixed-mode-processing] [--verbose-model-errors] 
[<mixed-mode-arguments>]

Authority

You do not need any authority to run this command.

Description

When you run the utility, it creates a file that is named toolkit.xml under the toolkit root directory.
Note: If you create a .namespace file in a directory, the command checks that the namespace corresponding to the directory path is mentioned in the toolkit.xml file as a namespace, even if the directory is empty.

Options and arguments

-c, --clean
Specifies to clean the .pm files and the toolkit.xml file.
-d, --description description
Specifies a description of the toolkit. The default value is "Toolkit Description".
-h, --help
Specifies to show the command syntax and help information.
-i, --directory toolkit-directory
Specifies the path to the toolkit root directory. This option is required unless you specify the -h or --help options.
-m, --make-operator
Specifies to run the spl-make-operator command on primitive operators to create the code generators.
mixed-mode-arguments
-n, --name name
Specifies the name of the toolkit. The default value is the name of the toolkit root directory.
--no-mixed-mode-processing
Controls the preprocessing of mixed-mode files. If this option is specified, mixed-mode .splmm files are not preprocessed. If unspecified, mixed-mode .splmm files are preprocessed to produce .spl files. The mixed-mode-arguments are used during the preprocessing.
-r, --product-version required-product-version
Specifies the version range of Teracloud® Streams that is required for using the toolkit. There are two valid formats:
  • For a minimal required version, use the same format as version. Any Teracloud® Streams version that is greater than or equal to this version is valid.
  • For a version range, the format is (\(|\[)\version,\version(\]|\)), where \version represents a version number. If the first character is [, then the Teracloud® Streams version must be greater than or equal (>=) to the first version, else it must be greater than (>) the first version. If the last character is ], then the Teracloud® Streams version must be less than or equal to (<=) the second version, otherwise it must be less than (<) the second version. If unspecified, the default value is 2.0. Some examples include [2.0, 2.2], [2.0, 2.2), (2.0,2.2], and (2.0,2.2).
-s, --silent
Specifies to pass the --silent option to the spl-make-operator command. This option is used with the -m and --make-operator options.
-v, --version version
Specifies the version of the toolkit. The format must be [0-9]+(.[0-9]+(.[0-9]+(.[a-zA-Z0-9 -]+)?)?)?. The default value is 1.0.0.
--verbose-model-errors
Specifies to run scripts to verify the operator model XML file, function model XML file, info.xml file, and toolkitList.xml file.

Examples

spl-make-toolkit -i toolkit -m -n "spl" -d "SPL Standard Toolkit" -v 2.0