module Pkg::Params

These are all of the parameters known to our packaging system. They are ingested by the config class as class instance variables

Constants

BUILD_PARAMS
DEFAULTS

Default values that are supplied if the user does not supply them

usage is the same as above

DEPRECATIONS

These are variables that we have deprecated. If they are encountered in a project's config, we issue deprecations for them.

ENV_VARS

Environment variable overrides for Pkg::Config parameters

:var  => :config_param,    :envvar => :environment var :type => :variable type

Note: :type is assumed :string if not present
REASSIGNMENTS

These are variables which, over time, we decided to rename or replace. For backwards compatibility, we assign the value of the old/deprecated variables, if set, to the new ones. We also use this method for accessor “redirects” - e.g. defaulting the populated value of one parameter for another in case it is not set.

VALIDATIONS

Provide an open-ended template for validating BUILD_PARAMS.

Each validatation contains the variable name as ':var' and a list of validations it must pass from the Pkg::Params::Validations class.