Name

SPVM::Document::EnvironmentVariables - Environment Variables

Description

This document explains environment variables.

Environment Variables

If an environment variable is an empty string, it is treated as an undefined value.

SPVM_BUILD_DIR

A directory for files generated by the compiler and linker.

C source codes for precompilation, dynamic link libraries and object files are stored into this directory.

These files are output when attempting to build a module containing methods with the native attribute or the precompile attribute.

If the SPVM_BUILD_DIR environment variable is defined, these files are output to the directory. If the directory does not exist, an exception is thrown.

If the SPVM_BUILD_DIR environment variable is not defined, a temporary directory is created at the beginning of the program, and the path is set to the environment variable.

Examples:

# bash
export SPVM_BUILD_DIR=~/.spvm_build

# csh
setenv SPVM_BUILD_DIR ~/.spvm_build

SPVM_CC_QUIET

If SPVM_CC_QUIET environement variable is a true value of Perl, messages SPVM native class compiler and linker are not printed to stderr.

If it is defined and a false value of Perl, the messages are printed.

This setting has a higher priority than SPVM::Builder::Config#quiet field.

Note that this environment variable is only effective during runtime compilation (JIT).

SPVM_CC_OPTIMIZE

If SPVM_CC_OPTIMIZE environment variable is defined, the optimize field is overwritten by this value.

This setting has a higher priority than SPVM::Builder::Config#optimize field.

Note that this environment variable is only effective during runtime compilation (JIT).

See Also

Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License