mk_option — Define an option
mk_option
OPTION=
option
VAR=
var
mk_option
VAR=
var
DEFAULT=
default
If the option is not specified by the user, var
will be set to default
.
PARAM=
name
A short descriptive name of the option value which will show up in the help text.
HELP=
text
A short snippet of text describing the option
Declares an option that can be passed by the user when configuring
the project and stored in var
. If the first form is used,
the option can be specified with --option
=... on the
command line. In either case, it may also be set by passing
var
=... on the command line, or setting the variable
in the environment or in a configuration file passed with @filename.
If name
and text
are provided, they will
be displayed in the output of --help.
This function can only be used within the option function in MakeKitBuild.