Skip to content

Commit

Permalink
Update common_settings_doc.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aranguyen authored Oct 21, 2024
1 parent 38285e5 commit 3beabf1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/common_settings_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ A bool-typed build setting that can be set on the command line
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="bool_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | universal |


<a id="bool_setting"></a>
Expand All @@ -42,6 +43,7 @@ A bool-typed build setting that cannot be set on the command line
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="bool_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | universal |


<a id="int_flag"></a>
Expand All @@ -61,6 +63,7 @@ An int-typed build setting that can be set on the command line
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="int_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="int_flag-make_variable"></a>make_variable | If set, the build setting's value will be available as a Make variable with this name in the attributes of rules that list this build setting in their 'toolchains' attribute. | String | optional | `""` |
| <a id="scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | universal |


<a id="int_setting"></a>
Expand All @@ -80,6 +83,7 @@ An int-typed build setting that cannot be set on the command line
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="int_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="int_setting-make_variable"></a>make_variable | If set, the build setting's value will be available as a Make variable with this name in the attributes of rules that list this build setting in their 'toolchains' attribute. | String | optional | `""` |
| <a id="scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | universal |


<a id="string_flag"></a>
Expand All @@ -100,6 +104,7 @@ A string-typed build setting that can be set on the command line
| <a id="string_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="string_flag-make_variable"></a>make_variable | If set, the build setting's value will be available as a Make variable with this name in the attributes of rules that list this build setting in their 'toolchains' attribute. | String | optional | `""` |
| <a id="string_flag-values"></a>values | The list of allowed values for this setting. An error is raised if any other value is given. | List of strings | optional | `[]` |
| <a id="scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | universal |


<a id="string_list_flag"></a>
Expand All @@ -118,6 +123,7 @@ A string list-typed build setting that can be set on the command line
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="string_list_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | universal |


<a id="string_list_setting"></a>
Expand All @@ -136,6 +142,7 @@ A string list-typed build setting that cannot be set on the command line
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="string_list_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | universal |


<a id="string_setting"></a>
Expand All @@ -156,6 +163,7 @@ A string-typed build setting that cannot be set on the command line
| <a id="string_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="string_setting-make_variable"></a>make_variable | If set, the build setting's value will be available as a Make variable with this name in the attributes of rules that list this build setting in their 'toolchains' attribute. | String | optional | `""` |
| <a id="string_setting-values"></a>values | The list of allowed values for this setting. An error is raised if any other value is given. | List of strings | optional | `[]` |
| <a id="scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | universal |


<a id="BuildSettingInfo"></a>
Expand Down

0 comments on commit 3beabf1

Please sign in to comment.