releng-tool¶
releng-tool can be used to assist in the building of a project. This tool allows a user to define one or more packages to process. Each package has the ability to perform several stages: fetching, extraction, patching, configuration, building and installation. What a package defines will vary for a given project. The simplest type of package is script-based that allows a user to define custom scripts on how to perform various stages. A package is not required to handle every stage. Helper package types are provided (e.g. autotools, CMake, etc.), for projects using common build capabilities.
While this tool can assist in the configuration and building of a project, the framework does not attempt to provide a perfect sandbox for the process. Users defining their projects will have ownership on what compilers/toolchains are used and the interaction between the staging/target area and the host system.
- Requirements
- Installation
- Getting started
- User guides
- Arguments
- Global actions
- Package actions
- Option arguments
--assets-dir <dir>
--cache-dir <dir>
--config <file>
--debug
-D
,--development [<mode>]
--dl-dir <dir>
-F
,--force
-h
,--help
--images-dir <dir>
-j
,--jobs <jobs>
-L
,--local-sources [[<pkg>:]<dir>]
--nocolorout
--out-dir <dir>
--relaxed-args
--root-dir <dir>
--sbom-format <fmt>
--quirk <quirk-id>
-V
,--verbose
--version
--werror
,-Werror
- Configuration
- Environment variables
- Common
BUILD_DIR
CACHE_DIR
DL_DIR
HOST_BIN_DIR
HOST_DIR
HOST_INCLUDE_DIR
HOST_LIB_DIR
IMAGES_DIR
LICENSE_DIR
NJOBS
NJOBSCONF
OUTPUT_DIR
PKG_BUILD_BASE_DIR
PKG_BUILD_DIR
PKG_BUILD_OUTPUT_DIR
PKG_CACHE_DIR
PKG_CACHE_FILE
PKG_DEFDIR
PKG_DEVMODE
PKG_INTERNAL
PKG_LOCALSRCS
PKG_NAME
PKG_REVISION
PKG_SITE
PKG_VERSION
PREFIX
PREFIXED_HOST_DIR
PREFIXED_STAGING_DIR
PREFIXED_TARGET_DIR
RELENG_CLEAN
RELENG_DEBUG
RELENG_DEVMODE
RELENG_DISTCLEAN
RELENG_FORCE
RELENG_LOCALSRCS
RELENG_MRPROPER
RELENG_REBUILD
RELENG_RECONFIGURE
RELENG_REINSTALL
RELENG_SCRIPT
RELENG_SCRIPT_DIR
RELENG_TARGET_PKG
RELENG_VERBOSE
RELENG_VERSION
ROOT_DIR
STAGING_BIN_DIR
STAGING_DIR
STAGING_INCLUDE_DIR
STAGING_LIB_DIR
SYMBOLS_DIR
TARGET_BIN_DIR
TARGET_DIR
TARGET_INCLUDE_DIR
TARGET_LIB_DIR
- Package-specific variables
- Script-only variables
- Other variables
- Common
- Packages
- Overview
- Topics
- Common options
- Advanced options
LIBFOO_BUILD_SUBDIR
LIBFOO_DEVMODE_IGNORE_CACHE
LIBFOO_DEVMODE_REVISION
LIBFOO_EXTENSION
LIBFOO_EXTERNAL
LIBFOO_EXTOPT
LIBFOO_EXTRACT_TYPE
LIBFOO_FETCH_OPTS
LIBFOO_FIXED_JOBS
LIBFOO_GIT_CONFIG
LIBFOO_GIT_DEPTH
LIBFOO_GIT_REFSPECS
LIBFOO_GIT_SUBMODULES
LIBFOO_GIT_VERIFY_REVISION
LIBFOO_HOST_PROVIDES
LIBFOO_INTERNAL
LIBFOO_NO_EXTRACTION
LIBFOO_PATCH_SUBDIR
LIBFOO_PREFIX
LIBFOO_REMOTE_CONFIG
LIBFOO_REMOTE_SCRIPTS
LIBFOO_REVISION
LIBFOO_STRIP_COUNT
LIBFOO_VCS_TYPE
- Bootstrapping
- Post-processing
- Site definitions
- Hash file
- ASCII armor
- Script package (default)
- Autotools package
- Cargo package
- CMake package
- Make package
- Meson package
- Python package
- SCons package
- Deprecated options
- Post-processing
- Script helpers
- Licenses
- Tips
- Advanced
- Patching
- Internal/external packages
- Development mode
- Local-sources mode
- Configuration overrides
- Quirks
- Command line quirks
- Configuration-driven quirks
- Available quirks
- releng.bzr.certifi
- releng.cmake.disable_direct_includes
- releng.cmake.disable_parallel_option
- releng.disable_prerequisites_check
- releng.disable_remote_configs
- releng.disable_remote_scripts
- releng.disable_spdx_check
- releng.git.no_depth
- releng.git.no_quick_fetch
- releng.git.replicate_cache
- releng.log.execute_env
- releng.stats.no_pdf
- Extensions
- Arguments
- Examples
- Requesting help
- Contributor guide
- ANNEX A - Quick reference