bazel-skylib/docs/common_settings_doc.md

6.0 KiB
Executable File

bool_flag

bool_flag(name)

A bool-typed build setting that can be set on the command line

Attributes

name Name; required

A unique name for this target.

bool_setting

bool_setting(name)

A bool-typed build setting that cannot be set on the command line

Attributes

name Name; required

A unique name for this target.

int_flag

int_flag(name)

An int-typed build setting that can be set on the command line

Attributes

name Name; required

A unique name for this target.

int_setting

int_setting(name)

An int-typed build setting that cannot be set on the command line

Attributes

name Name; required

A unique name for this target.

string_flag

string_flag(name, values)

A string-typed build setting that can be set on the command line

Attributes

name Name; required

A unique name for this target.

values List of strings; optional

The list of allowed values for this setting. An error is raised if any other value is given.

string_list_flag

string_list_flag(name)

A string list-typed build setting that can be set on the command line

Attributes

name Name; required

A unique name for this target.

string_list_setting

string_list_setting(name)

A string list-typed build setting that cannot be set on the command line

Attributes

name Name; required

A unique name for this target.

string_setting

string_setting(name, values)

A string-typed build setting that cannot be set on the command line

Attributes

name Name; required

A unique name for this target.

values List of strings; optional

The list of allowed values for this setting. An error is raised if any other value is given.

BuildSettingInfo

BuildSettingInfo(value)

A singleton provider that contains the raw value of a build setting

Fields

value

The value of the build setting in the current configuration. This value may come from the command line or an upstream transition, or else it will be the build setting's default.