• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!-- Generated with Stardoc: http://skydoc.bazel.build -->
2
3<a name="#bool_flag"></a>
4
5## bool_flag
6
7<pre>
8bool_flag(<a href="#bool_flag-name">name</a>)
9</pre>
10
11A bool-typed build setting that can be set on the command line
12
13### Attributes
14
15<table class="params-table">
16  <colgroup>
17    <col class="col-param" />
18    <col class="col-description" />
19  </colgroup>
20  <tbody>
21    <tr id="bool_flag-name">
22      <td><code>name</code></td>
23      <td>
24        <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
25        <p>
26          A unique name for this target.
27        </p>
28      </td>
29    </tr>
30  </tbody>
31</table>
32
33
34<a name="#bool_setting"></a>
35
36## bool_setting
37
38<pre>
39bool_setting(<a href="#bool_setting-name">name</a>)
40</pre>
41
42A bool-typed build setting that cannot be set on the command line
43
44### Attributes
45
46<table class="params-table">
47  <colgroup>
48    <col class="col-param" />
49    <col class="col-description" />
50  </colgroup>
51  <tbody>
52    <tr id="bool_setting-name">
53      <td><code>name</code></td>
54      <td>
55        <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
56        <p>
57          A unique name for this target.
58        </p>
59      </td>
60    </tr>
61  </tbody>
62</table>
63
64
65<a name="#int_flag"></a>
66
67## int_flag
68
69<pre>
70int_flag(<a href="#int_flag-name">name</a>)
71</pre>
72
73An int-typed build setting that can be set on the command line
74
75### Attributes
76
77<table class="params-table">
78  <colgroup>
79    <col class="col-param" />
80    <col class="col-description" />
81  </colgroup>
82  <tbody>
83    <tr id="int_flag-name">
84      <td><code>name</code></td>
85      <td>
86        <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
87        <p>
88          A unique name for this target.
89        </p>
90      </td>
91    </tr>
92  </tbody>
93</table>
94
95
96<a name="#int_setting"></a>
97
98## int_setting
99
100<pre>
101int_setting(<a href="#int_setting-name">name</a>)
102</pre>
103
104An int-typed build setting that cannot be set on the command line
105
106### Attributes
107
108<table class="params-table">
109  <colgroup>
110    <col class="col-param" />
111    <col class="col-description" />
112  </colgroup>
113  <tbody>
114    <tr id="int_setting-name">
115      <td><code>name</code></td>
116      <td>
117        <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
118        <p>
119          A unique name for this target.
120        </p>
121      </td>
122    </tr>
123  </tbody>
124</table>
125
126
127<a name="#string_flag"></a>
128
129## string_flag
130
131<pre>
132string_flag(<a href="#string_flag-name">name</a>, <a href="#string_flag-values">values</a>)
133</pre>
134
135A string-typed build setting that can be set on the command line
136
137### Attributes
138
139<table class="params-table">
140  <colgroup>
141    <col class="col-param" />
142    <col class="col-description" />
143  </colgroup>
144  <tbody>
145    <tr id="string_flag-name">
146      <td><code>name</code></td>
147      <td>
148        <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
149        <p>
150          A unique name for this target.
151        </p>
152      </td>
153    </tr>
154    <tr id="string_flag-values">
155      <td><code>values</code></td>
156      <td>
157        List of strings; optional
158        <p>
159          The list of allowed values for this setting. An error is raised if any other value is given.
160        </p>
161      </td>
162    </tr>
163  </tbody>
164</table>
165
166
167<a name="#string_list_flag"></a>
168
169## string_list_flag
170
171<pre>
172string_list_flag(<a href="#string_list_flag-name">name</a>)
173</pre>
174
175A string list-typed build setting that can be set on the command line
176
177### Attributes
178
179<table class="params-table">
180  <colgroup>
181    <col class="col-param" />
182    <col class="col-description" />
183  </colgroup>
184  <tbody>
185    <tr id="string_list_flag-name">
186      <td><code>name</code></td>
187      <td>
188        <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
189        <p>
190          A unique name for this target.
191        </p>
192      </td>
193    </tr>
194  </tbody>
195</table>
196
197
198<a name="#string_list_setting"></a>
199
200## string_list_setting
201
202<pre>
203string_list_setting(<a href="#string_list_setting-name">name</a>)
204</pre>
205
206A string list-typed build setting that cannot be set on the command line
207
208### Attributes
209
210<table class="params-table">
211  <colgroup>
212    <col class="col-param" />
213    <col class="col-description" />
214  </colgroup>
215  <tbody>
216    <tr id="string_list_setting-name">
217      <td><code>name</code></td>
218      <td>
219        <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
220        <p>
221          A unique name for this target.
222        </p>
223      </td>
224    </tr>
225  </tbody>
226</table>
227
228
229<a name="#string_setting"></a>
230
231## string_setting
232
233<pre>
234string_setting(<a href="#string_setting-name">name</a>, <a href="#string_setting-values">values</a>)
235</pre>
236
237A string-typed build setting that cannot be set on the command line
238
239### Attributes
240
241<table class="params-table">
242  <colgroup>
243    <col class="col-param" />
244    <col class="col-description" />
245  </colgroup>
246  <tbody>
247    <tr id="string_setting-name">
248      <td><code>name</code></td>
249      <td>
250        <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
251        <p>
252          A unique name for this target.
253        </p>
254      </td>
255    </tr>
256    <tr id="string_setting-values">
257      <td><code>values</code></td>
258      <td>
259        List of strings; optional
260        <p>
261          The list of allowed values for this setting. An error is raised if any other value is given.
262        </p>
263      </td>
264    </tr>
265  </tbody>
266</table>
267
268
269<a name="#BuildSettingInfo"></a>
270
271## BuildSettingInfo
272
273<pre>
274BuildSettingInfo(<a href="#BuildSettingInfo-value">value</a>)
275</pre>
276
277A singleton provider that contains the raw value of a build setting
278
279### Fields
280
281<table class="params-table">
282  <colgroup>
283    <col class="col-param" />
284    <col class="col-description" />
285  </colgroup>
286  <tbody>
287    <tr id="BuildSettingInfo-value">
288      <td><code>value</code></td>
289      <td>
290        <p>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.</p>
291      </td>
292    </tr>
293  </tbody>
294</table>
295
296
297