bake-toolkit 2.28.1 → 2.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/documentation/_build/html/_sources/changelog.txt +5 -0
- data/documentation/_build/html/_sources/index.txt +1 -1
- data/documentation/_build/html/_sources/syntax/adapt_configs.txt +21 -0
- data/documentation/_build/html/_static/syntax.html +10 -0
- data/documentation/_build/html/changelog.html +1161 -1154
- data/documentation/_build/html/genindex.html +152 -152
- data/documentation/_build/html/index.html +246 -246
- data/documentation/_build/html/search.html +174 -174
- data/documentation/_build/html/searchindex.js +1 -1
- data/documentation/_build/html/syntax/adapt_configs.html +388 -370
- data/documentation/_build/html/syntax/project_meta_syntax.html +933 -923
- data/documentation/_build/html/syntax/syntax.html +197 -196
- data/lib/bake/config/loader.rb +24 -9
- data/lib/bake/model/metamodel.rb +5 -0
- data/lib/bake/options/usage.rb +2 -2
- data/lib/blocks/block.rb +10 -1
- data/lib/blocks/commandLine.rb +11 -5
- data/lib/blocks/makefile.rb +16 -6
- data/lib/common/version.rb +1 -1
- data/lib/tocxx.rb +3 -2
- metadata +1 -1
@@ -1,924 +1,934 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml">
|
5
|
-
<head>
|
6
|
-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
7
|
-
|
8
|
-
<title>The Syntax of the Project.meta file — bake documentation</title>
|
9
|
-
|
10
|
-
<link rel="stylesheet" href="../_static/basic.css" type="text/css" />
|
11
|
-
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
12
|
-
<link rel="stylesheet" href="../_static/bootswatch-3.3.4/sandstone/bootstrap.min.css" type="text/css" />
|
13
|
-
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
|
14
|
-
|
15
|
-
<script type="text/javascript">
|
16
|
-
var DOCUMENTATION_OPTIONS = {
|
17
|
-
URL_ROOT: '../',
|
18
|
-
VERSION: '',
|
19
|
-
COLLAPSE_INDEX: false,
|
20
|
-
FILE_SUFFIX: '.html',
|
21
|
-
HAS_SOURCE: true
|
22
|
-
};
|
23
|
-
</script>
|
24
|
-
<script type="text/javascript" src="../_static/jquery.js"></script>
|
25
|
-
<script type="text/javascript" src="../_static/underscore.js"></script>
|
26
|
-
<script type="text/javascript" src="../_static/doctools.js"></script>
|
27
|
-
<script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
|
28
|
-
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
|
29
|
-
<script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
|
30
|
-
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
|
31
|
-
<link rel="shortcut icon" href="../_static/logo_tiny_32.ico"/>
|
32
|
-
<link rel="top" title="bake documentation" href="../index.html" />
|
33
|
-
<link rel="up" title="Syntax" href="syntax.html" />
|
34
|
-
<link rel="next" title="Variables in Project.meta" href="variable_substitutions.html" />
|
35
|
-
<link rel="prev" title="Syntax" href="syntax.html" />
|
36
|
-
<meta charset='utf-8'>
|
37
|
-
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
|
38
|
-
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
|
39
|
-
<meta name="apple-mobile-web-app-capable" content="yes">
|
40
|
-
|
41
|
-
</head>
|
42
|
-
<body role="document">
|
43
|
-
|
44
|
-
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
|
45
|
-
<div class="container">
|
46
|
-
<div class="navbar-header">
|
47
|
-
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
|
48
|
-
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
|
49
|
-
<span class="icon-bar"></span>
|
50
|
-
<span class="icon-bar"></span>
|
51
|
-
<span class="icon-bar"></span>
|
52
|
-
</button>
|
53
|
-
<a class="navbar-brand" href="../index.html"><img src="../_static/logo_tiny_48.png">
|
54
|
-
</a>
|
55
|
-
<span class="navbar-text navbar-version pull-left"><b></b></span>
|
56
|
-
</div>
|
57
|
-
|
58
|
-
<div class="collapse navbar-collapse nav-collapse">
|
59
|
-
<ul class="nav navbar-nav">
|
60
|
-
|
61
|
-
|
62
|
-
<li class="dropdown globaltoc-container">
|
63
|
-
<a role="button"
|
64
|
-
id="dLabelGlobalToc"
|
65
|
-
data-toggle="dropdown"
|
66
|
-
data-target="#"
|
67
|
-
href="../index.html">Section <b class="caret"></b></a>
|
68
|
-
<ul class="dropdown-menu globaltoc"
|
69
|
-
role="menu"
|
70
|
-
aria-labelledby="dLabelGlobalToc"><ul class="current">
|
71
|
-
<li class="toctree-l1"><a class="reference internal" href="../why_bake/why_bake.html">Why you should use bake</a></li>
|
72
|
-
<li class="toctree-l1"><a class="reference internal" href="../install/install_bake.html">Install bake</a></li>
|
73
|
-
<li class="toctree-l1"><a class="reference internal" href="../quickstart/quickstart.html">Quickstart</a></li>
|
74
|
-
<li class="toctree-l1"><a class="reference internal" href="../concepts/concepts.html">Concepts</a></li>
|
75
|
-
<li class="toctree-l1 current"><a class="reference internal" href="syntax.html">Syntax</a></li>
|
76
|
-
<li class="toctree-l1"><a class="reference internal" href="../commandline/commandline.html">Commandline</a></li>
|
77
|
-
<li class="toctree-l1"><a class="reference internal" href="../ide/ide_integrations.html">IDE Support</a></li>
|
78
|
-
<li class="toctree-l1"><a class="reference internal" href="../tips_and_tricks/tips_and_tricks.html">Additional features</a></li>
|
79
|
-
<li class="toctree-l1"><a class="reference internal" href="../performance/performance.html">Performance</a></li>
|
80
|
-
<li class="toctree-l1"><a class="reference internal" href="../known_issues.html">Known Issues</a></li>
|
81
|
-
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
|
82
|
-
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
|
83
|
-
</ul>
|
84
|
-
<ul>
|
85
|
-
<li class="toctree-l1"><a class="reference internal" href="../internal.html">Internal developing notes</a></li>
|
86
|
-
</ul>
|
87
|
-
</ul>
|
88
|
-
</li>
|
89
|
-
|
90
|
-
<li class="dropdown">
|
91
|
-
<a role="button"
|
92
|
-
id="dLabelLocalToc"
|
93
|
-
data-toggle="dropdown"
|
94
|
-
data-target="#"
|
95
|
-
href="#">SubSections <b class="caret"></b></a>
|
96
|
-
<ul class="dropdown-menu localtoc"
|
97
|
-
role="menu"
|
98
|
-
aria-labelledby="dLabelLocalToc"><ul>
|
99
|
-
<li><a class="reference internal" href="#">The Syntax of the Project.meta file</a><ul>
|
100
|
-
<li><a class="reference internal" href="#instructions-for-the-interactive-syntax-viewer">Instructions for the Interactive Syntax Viewer</a></li>
|
101
|
-
</ul>
|
102
|
-
</li>
|
103
|
-
</ul>
|
104
|
-
</ul>
|
105
|
-
</li>
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
<li>
|
112
|
-
<a href="syntax.html" title="Previous Chapter: Syntax"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Syntax</span>
|
113
|
-
</a>
|
114
|
-
</li>
|
115
|
-
<li>
|
116
|
-
<a href="variable_substitutions.html" title="Next Chapter: Variables in Project.meta"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Variables in ... »</span>
|
117
|
-
</a>
|
118
|
-
</li>
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
</ul>
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
<form class="navbar-form navbar-right" action="../search.html" method="get">
|
129
|
-
<div class="form-group">
|
130
|
-
<input type="text" name="q" class="form-control" placeholder="Search" />
|
131
|
-
</div>
|
132
|
-
<input type="hidden" name="check_keywords" value="yes" />
|
133
|
-
<input type="hidden" name="area" value="default" />
|
134
|
-
</form>
|
135
|
-
|
136
|
-
</div>
|
137
|
-
</div>
|
138
|
-
</div>
|
139
|
-
|
140
|
-
<div class="container">
|
141
|
-
<div class="row">
|
142
|
-
<div class="col-md-12">
|
143
|
-
|
144
|
-
<div class="section" id="the-syntax-of-the-project-meta-file">
|
145
|
-
<h1>The Syntax of the Project.meta file<a class="headerlink" href="#the-syntax-of-the-project-meta-file" title="Permalink to this headline">¶</a></h1>
|
146
|
-
<div class="section" id="instructions-for-the-interactive-syntax-viewer">
|
147
|
-
<h2>Instructions for the Interactive Syntax Viewer<a class="headerlink" href="#instructions-for-the-interactive-syntax-viewer" title="Permalink to this headline">¶</a></h2>
|
148
|
-
<ul class="simple">
|
149
|
-
<li>Move the mouse cursor over the blue elements to display more information.</li>
|
150
|
-
<li>Three config types exist: ExecutableConfig, LibraryConfig and CustomConfig. Move the mouse cursor over these elements to display the supported content.</li>
|
151
|
-
</ul>
|
152
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
153
|
-
"http://www.w3.org/TR/html4/strict.dtd">
|
154
|
-
<html>
|
155
|
-
<head></head>
|
156
|
-
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
157
|
-
|
158
|
-
<body >
|
159
|
-
|
160
|
-
<style type="text/css">
|
161
|
-
|
162
|
-
#dhtmltooltip{
|
163
|
-
position: absolute;
|
164
|
-
width: 150px;
|
165
|
-
border: 2px solid black;
|
166
|
-
padding: 2px;
|
167
|
-
background-color: lightyellow;
|
168
|
-
visibility: hidden;
|
169
|
-
z-index: 100;
|
170
|
-
}
|
171
|
-
|
172
|
-
</style>
|
173
|
-
|
174
|
-
<style type="text/css">
|
175
|
-
.hide {
|
176
|
-
display:none;
|
177
|
-
}
|
178
|
-
.show {
|
179
|
-
display:block
|
180
|
-
}
|
181
|
-
.showInline {
|
182
|
-
display:inline
|
183
|
-
}
|
184
|
-
.help {
|
185
|
-
color:blue
|
186
|
-
}
|
187
|
-
.showRadio {
|
188
|
-
font-weight:bold;color:blue;text-decoration:overline underline
|
189
|
-
}
|
190
|
-
.hideRadio {
|
191
|
-
color:#AAAAFF;
|
192
|
-
}
|
193
|
-
.mycomment {
|
194
|
-
color:green
|
195
|
-
}
|
196
|
-
</style>
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
<table border="1" style="font-family:monospace"; font-size:10><td>
|
203
|
-
|
204
|
-
<span class="help" onMouseover="showProject()" onMouseout="notip()">Project</span> <span class="help" onMouseover="showDefaultConfig()" onMouseout="notip()">default</span>: <name> {<br>
|
205
|
-
<br>
|
206
|
-
|
207
|
-
<span class="help" onMouseover="showDescription()" onMouseout="notip()">Description</span> <text><br><br>
|
208
|
-
|
209
|
-
<span class="help" onMouseover="showVersion()" onMouseout="notip()">RequiredBakeVersion</span> minimum: <major.minor.patch>, maximum: <major.minor.patch><br><br>
|
210
|
-
|
211
|
-
<span class="help" onMouseover="showResponsible()" onMouseout="notip()">Responsible</span> {<br>
|
212
|
-
<span class="help" onMouseover="showPerson()" onMouseout="notip()">Person</span> <name>,
|
213
|
-
<span class="help" onMouseover="showPersonEmail()" onMouseout="notip()">email</span>: <adr><br>
|
214
|
-
}<br><br>
|
215
|
-
|
216
|
-
<span class="mycomment"># 0..n configs</span><br>
|
217
|
-
<span class="showRadio" onMouseover="showExecutableConfig()" onMouseout="notip()" id="executableConfig">ExecutableConfig</span> |
|
218
|
-
<span class="hideRadio" onMouseover="showLibraryConfig()" onMouseout="notip()" id="libraryConfig">LibraryConfig</span> |
|
219
|
-
<span class="hideRadio" onMouseover="showCustomConfig()" onMouseout="notip()" id="customConfig">CustomConfig</span> <name>,
|
220
|
-
<span class="help" onMouseover="showExtends()" onMouseout="notip()">extends</span>: <parent(s)>,
|
221
|
-
<span class="help" onMouseover="showPrivate()" onMouseout="notip()">private</span>: true|false {<br><br>
|
222
|
-
|
223
|
-
<span><span style="background-color:#EEEEEE;" class="show">
|
224
|
-
<span class="mycomment"># Valid for all config types</span><br><br>
|
225
|
-
<span class="help" onMouseover="showDescription()" onMouseout="notip()">Description</span> <text><br>
|
226
|
-
<span class="help" onMouseover="showIncludeDir()" onMouseout="notip()">IncludeDir</span> <dir>, <span class="help" onMouseover="showInherit()" onMouseout="notip()">inherit</span>: true|false, <span class="help" onMouseover="showInfix()" onMouseout="notip()">inject</span>: front|back, <span class="help" onMouseover="showSystemInclude()" onMouseout="notip()">system</span>: true|false<br>
|
227
|
-
<span class="help" onMouseover="showSet()" onMouseout="notip()">Set</span> <variable>, value: <value> | cmd: <line>, <span class="help" onMouseover="showEnv()" onMouseout="notip()">env</span>: true|false<br>
|
228
|
-
<span class="help" onMouseover="showDependency()" onMouseout="notip()">Dependency</span> <project>,
|
229
|
-
<span class="help" onMouseover="showDependencyConfig()" onMouseout="notip()">config</span>: <name><br>
|
230
|
-
<span class="help" onMouseover="showExternalLibrary()" onMouseout="notip()">ExternalLibrary</span> <lib>,
|
231
|
-
<span class="help" onMouseover="showExternalLibrarySearch()" onMouseout="notip()">search</span>: true|false<br>
|
232
|
-
<span class="help" onMouseover="showUserLibrary()" onMouseout="notip()">UserLibrary</span> <lib><br>
|
233
|
-
<span class="help" onMouseover="showExternalLibrarySearchPath()" onMouseout="notip()">ExternalLibrarySearchPath</span> <path><br>
|
234
|
-
<span class="help" onMouseover="showPreSteps()" onMouseout="notip()">PreSteps</span> {<br>
|
235
|
-
<span class="help" onMouseover="showMakefile()" onMouseout="notip()">Makefile</span> <file>,
|
236
|
-
<span class="help" onMouseover="showMakefileLib()" onMouseout="notip()">lib</span>: <lib>,
|
237
|
-
<span class="help" onMouseover="showMakefileTarget()" onMouseout="notip()">target</span>: <target>,
|
238
|
-
<span class="help" onMouseover="showMakefilePathTo()" onMouseout="notip()">pathTo</span>: <paths>,
|
239
|
-
<span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
|
240
|
-
<span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: <name>,
|
241
|
-
<span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
|
242
|
-
<span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: <[array]> {<br>
|
243
|
-
<span class="help" onMouseover="showMakefileFlags()" onMouseout="notip()">Flags</span> <flags><br>
|
244
|
-
}<br>
|
245
|
-
<span class="help" onMouseover="showCommandLine()" onMouseout="notip()">CommandLine</span> <line>,
|
246
|
-
<span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
|
247
|
-
<span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: <name>,
|
248
|
-
<span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
|
249
|
-
<span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: <[array]><br>
|
250
|
-
}<br>
|
251
|
-
<span class="help" onMouseover="showPostSteps()" onMouseout="notip()">PostSteps</span> {<br>
|
252
|
-
<span class="mycomment"># Same as for PreSteps</span><br>
|
253
|
-
}<br>
|
254
|
-
<span class="help" onMouseover="showStartupSteps()" onMouseout="notip()">StartupSteps</span> {<br>
|
255
|
-
<span class="mycomment"># Same as for PreSteps</span><br>
|
256
|
-
}<br>
|
257
|
-
<span class="help" onMouseover="showExitSteps()" onMouseout="notip()">ExitSteps</span> {<br>
|
258
|
-
<span class="mycomment"># Same as for PreSteps</span><br>
|
259
|
-
}<br>
|
260
|
-
<span class="help" onMouseover="
|
261
|
-
<span class="
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
<span class="help" onMouseover="
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
<span class="help" onMouseover="
|
278
|
-
<span class="help" onMouseover="
|
279
|
-
}<br>
|
280
|
-
|
281
|
-
|
282
|
-
<
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
<span class="help" onMouseover="
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
<span class="help" onMouseover="
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
</span>
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
<span class="help" onMouseover="
|
314
|
-
<span class="help" onMouseover="
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
</span><br
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
<span
|
342
|
-
<span class="help" onMouseover="
|
343
|
-
</span
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
<
|
349
|
-
}<br>
|
350
|
-
|
351
|
-
|
352
|
-
<
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
'
|
369
|
-
'
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
document.getElementById('
|
405
|
-
document.getElementById('
|
406
|
-
document.getElementById('
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
document.getElementById('
|
417
|
-
document.getElementById('
|
418
|
-
document.getElementById('
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
document.getElementById('
|
429
|
-
document.getElementById('
|
430
|
-
document.getElementById('
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
'will
|
461
|
-
'"xy/z"
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
ddrivetip("
|
529
|
-
}
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
ddrivetip("
|
539
|
-
}
|
540
|
-
|
541
|
-
function
|
542
|
-
str = '
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
'
|
561
|
-
|
562
|
-
}
|
563
|
-
|
564
|
-
function
|
565
|
-
|
566
|
-
}
|
567
|
-
|
568
|
-
|
569
|
-
|
570
|
-
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
ddrivetip("
|
576
|
-
}
|
577
|
-
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
ddrivetip("
|
586
|
-
}
|
587
|
-
|
588
|
-
function
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
'
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
'
|
621
|
-
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
|
627
|
-
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
ddrivetip("
|
637
|
-
}
|
638
|
-
|
639
|
-
function
|
640
|
-
str = '
|
641
|
-
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
666
|
-
|
667
|
-
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
}
|
677
|
-
|
678
|
-
function
|
679
|
-
str = '
|
680
|
-
|
681
|
-
}
|
682
|
-
|
683
|
-
function
|
684
|
-
str = '
|
685
|
-
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
|
699
|
-
|
700
|
-
document.getElementById('
|
701
|
-
document.getElementById('
|
702
|
-
|
703
|
-
|
704
|
-
|
705
|
-
|
706
|
-
|
707
|
-
|
708
|
-
|
709
|
-
|
710
|
-
|
711
|
-
|
712
|
-
|
713
|
-
|
714
|
-
|
715
|
-
|
716
|
-
"
|
717
|
-
"
|
718
|
-
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
}
|
729
|
-
|
730
|
-
function
|
731
|
-
str = '
|
732
|
-
ddrivetip("
|
733
|
-
}
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
ddrivetip("
|
749
|
-
}
|
750
|
-
|
751
|
-
function
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
|
760
|
-
|
761
|
-
|
762
|
-
|
763
|
-
|
764
|
-
|
765
|
-
|
766
|
-
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
779
|
-
|
780
|
-
|
781
|
-
|
782
|
-
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
818
|
-
|
819
|
-
|
820
|
-
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
|
825
|
-
|
826
|
-
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
|
834
|
-
|
835
|
-
|
836
|
-
|
837
|
-
|
838
|
-
|
839
|
-
|
840
|
-
|
841
|
-
|
842
|
-
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
|
854
|
-
|
855
|
-
|
856
|
-
|
857
|
-
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
|
862
|
-
|
863
|
-
|
864
|
-
|
865
|
-
|
866
|
-
|
867
|
-
//
|
868
|
-
if (
|
869
|
-
|
870
|
-
|
871
|
-
|
872
|
-
tipobj.style.
|
873
|
-
|
874
|
-
|
875
|
-
|
876
|
-
|
877
|
-
|
878
|
-
if (
|
879
|
-
|
880
|
-
|
881
|
-
tipobj.style.
|
882
|
-
tipobj.style.
|
883
|
-
|
884
|
-
}
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
|
892
|
-
|
893
|
-
|
894
|
-
|
895
|
-
|
896
|
-
|
897
|
-
|
898
|
-
|
899
|
-
|
900
|
-
|
901
|
-
</
|
902
|
-
|
903
|
-
</
|
904
|
-
</
|
905
|
-
|
906
|
-
|
907
|
-
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
|
913
|
-
|
914
|
-
|
915
|
-
|
916
|
-
|
917
|
-
|
918
|
-
|
919
|
-
|
920
|
-
|
921
|
-
|
922
|
-
|
923
|
-
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml">
|
5
|
+
<head>
|
6
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
7
|
+
|
8
|
+
<title>The Syntax of the Project.meta file — bake documentation</title>
|
9
|
+
|
10
|
+
<link rel="stylesheet" href="../_static/basic.css" type="text/css" />
|
11
|
+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
12
|
+
<link rel="stylesheet" href="../_static/bootswatch-3.3.4/sandstone/bootstrap.min.css" type="text/css" />
|
13
|
+
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
|
14
|
+
|
15
|
+
<script type="text/javascript">
|
16
|
+
var DOCUMENTATION_OPTIONS = {
|
17
|
+
URL_ROOT: '../',
|
18
|
+
VERSION: '',
|
19
|
+
COLLAPSE_INDEX: false,
|
20
|
+
FILE_SUFFIX: '.html',
|
21
|
+
HAS_SOURCE: true
|
22
|
+
};
|
23
|
+
</script>
|
24
|
+
<script type="text/javascript" src="../_static/jquery.js"></script>
|
25
|
+
<script type="text/javascript" src="../_static/underscore.js"></script>
|
26
|
+
<script type="text/javascript" src="../_static/doctools.js"></script>
|
27
|
+
<script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
|
28
|
+
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
|
29
|
+
<script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
|
30
|
+
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
|
31
|
+
<link rel="shortcut icon" href="../_static/logo_tiny_32.ico"/>
|
32
|
+
<link rel="top" title="bake documentation" href="../index.html" />
|
33
|
+
<link rel="up" title="Syntax" href="syntax.html" />
|
34
|
+
<link rel="next" title="Variables in Project.meta" href="variable_substitutions.html" />
|
35
|
+
<link rel="prev" title="Syntax" href="syntax.html" />
|
36
|
+
<meta charset='utf-8'>
|
37
|
+
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
|
38
|
+
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
|
39
|
+
<meta name="apple-mobile-web-app-capable" content="yes">
|
40
|
+
|
41
|
+
</head>
|
42
|
+
<body role="document">
|
43
|
+
|
44
|
+
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
|
45
|
+
<div class="container">
|
46
|
+
<div class="navbar-header">
|
47
|
+
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
|
48
|
+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
|
49
|
+
<span class="icon-bar"></span>
|
50
|
+
<span class="icon-bar"></span>
|
51
|
+
<span class="icon-bar"></span>
|
52
|
+
</button>
|
53
|
+
<a class="navbar-brand" href="../index.html"><img src="../_static/logo_tiny_48.png">
|
54
|
+
</a>
|
55
|
+
<span class="navbar-text navbar-version pull-left"><b></b></span>
|
56
|
+
</div>
|
57
|
+
|
58
|
+
<div class="collapse navbar-collapse nav-collapse">
|
59
|
+
<ul class="nav navbar-nav">
|
60
|
+
|
61
|
+
|
62
|
+
<li class="dropdown globaltoc-container">
|
63
|
+
<a role="button"
|
64
|
+
id="dLabelGlobalToc"
|
65
|
+
data-toggle="dropdown"
|
66
|
+
data-target="#"
|
67
|
+
href="../index.html">Section <b class="caret"></b></a>
|
68
|
+
<ul class="dropdown-menu globaltoc"
|
69
|
+
role="menu"
|
70
|
+
aria-labelledby="dLabelGlobalToc"><ul class="current">
|
71
|
+
<li class="toctree-l1"><a class="reference internal" href="../why_bake/why_bake.html">Why you should use bake</a></li>
|
72
|
+
<li class="toctree-l1"><a class="reference internal" href="../install/install_bake.html">Install bake</a></li>
|
73
|
+
<li class="toctree-l1"><a class="reference internal" href="../quickstart/quickstart.html">Quickstart</a></li>
|
74
|
+
<li class="toctree-l1"><a class="reference internal" href="../concepts/concepts.html">Concepts</a></li>
|
75
|
+
<li class="toctree-l1 current"><a class="reference internal" href="syntax.html">Syntax</a></li>
|
76
|
+
<li class="toctree-l1"><a class="reference internal" href="../commandline/commandline.html">Commandline</a></li>
|
77
|
+
<li class="toctree-l1"><a class="reference internal" href="../ide/ide_integrations.html">IDE Support</a></li>
|
78
|
+
<li class="toctree-l1"><a class="reference internal" href="../tips_and_tricks/tips_and_tricks.html">Additional features</a></li>
|
79
|
+
<li class="toctree-l1"><a class="reference internal" href="../performance/performance.html">Performance</a></li>
|
80
|
+
<li class="toctree-l1"><a class="reference internal" href="../known_issues.html">Known Issues</a></li>
|
81
|
+
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
|
82
|
+
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
|
83
|
+
</ul>
|
84
|
+
<ul>
|
85
|
+
<li class="toctree-l1"><a class="reference internal" href="../internal.html">Internal developing notes</a></li>
|
86
|
+
</ul>
|
87
|
+
</ul>
|
88
|
+
</li>
|
89
|
+
|
90
|
+
<li class="dropdown">
|
91
|
+
<a role="button"
|
92
|
+
id="dLabelLocalToc"
|
93
|
+
data-toggle="dropdown"
|
94
|
+
data-target="#"
|
95
|
+
href="#">SubSections <b class="caret"></b></a>
|
96
|
+
<ul class="dropdown-menu localtoc"
|
97
|
+
role="menu"
|
98
|
+
aria-labelledby="dLabelLocalToc"><ul>
|
99
|
+
<li><a class="reference internal" href="#">The Syntax of the Project.meta file</a><ul>
|
100
|
+
<li><a class="reference internal" href="#instructions-for-the-interactive-syntax-viewer">Instructions for the Interactive Syntax Viewer</a></li>
|
101
|
+
</ul>
|
102
|
+
</li>
|
103
|
+
</ul>
|
104
|
+
</ul>
|
105
|
+
</li>
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
<li>
|
112
|
+
<a href="syntax.html" title="Previous Chapter: Syntax"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Syntax</span>
|
113
|
+
</a>
|
114
|
+
</li>
|
115
|
+
<li>
|
116
|
+
<a href="variable_substitutions.html" title="Next Chapter: Variables in Project.meta"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Variables in ... »</span>
|
117
|
+
</a>
|
118
|
+
</li>
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
</ul>
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
<form class="navbar-form navbar-right" action="../search.html" method="get">
|
129
|
+
<div class="form-group">
|
130
|
+
<input type="text" name="q" class="form-control" placeholder="Search" />
|
131
|
+
</div>
|
132
|
+
<input type="hidden" name="check_keywords" value="yes" />
|
133
|
+
<input type="hidden" name="area" value="default" />
|
134
|
+
</form>
|
135
|
+
|
136
|
+
</div>
|
137
|
+
</div>
|
138
|
+
</div>
|
139
|
+
|
140
|
+
<div class="container">
|
141
|
+
<div class="row">
|
142
|
+
<div class="col-md-12">
|
143
|
+
|
144
|
+
<div class="section" id="the-syntax-of-the-project-meta-file">
|
145
|
+
<h1>The Syntax of the Project.meta file<a class="headerlink" href="#the-syntax-of-the-project-meta-file" title="Permalink to this headline">¶</a></h1>
|
146
|
+
<div class="section" id="instructions-for-the-interactive-syntax-viewer">
|
147
|
+
<h2>Instructions for the Interactive Syntax Viewer<a class="headerlink" href="#instructions-for-the-interactive-syntax-viewer" title="Permalink to this headline">¶</a></h2>
|
148
|
+
<ul class="simple">
|
149
|
+
<li>Move the mouse cursor over the blue elements to display more information.</li>
|
150
|
+
<li>Three config types exist: ExecutableConfig, LibraryConfig and CustomConfig. Move the mouse cursor over these elements to display the supported content.</li>
|
151
|
+
</ul>
|
152
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
153
|
+
"http://www.w3.org/TR/html4/strict.dtd">
|
154
|
+
<html>
|
155
|
+
<head></head>
|
156
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
157
|
+
|
158
|
+
<body >
|
159
|
+
|
160
|
+
<style type="text/css">
|
161
|
+
|
162
|
+
#dhtmltooltip{
|
163
|
+
position: absolute;
|
164
|
+
width: 150px;
|
165
|
+
border: 2px solid black;
|
166
|
+
padding: 2px;
|
167
|
+
background-color: lightyellow;
|
168
|
+
visibility: hidden;
|
169
|
+
z-index: 100;
|
170
|
+
}
|
171
|
+
|
172
|
+
</style>
|
173
|
+
|
174
|
+
<style type="text/css">
|
175
|
+
.hide {
|
176
|
+
display:none;
|
177
|
+
}
|
178
|
+
.show {
|
179
|
+
display:block
|
180
|
+
}
|
181
|
+
.showInline {
|
182
|
+
display:inline
|
183
|
+
}
|
184
|
+
.help {
|
185
|
+
color:blue
|
186
|
+
}
|
187
|
+
.showRadio {
|
188
|
+
font-weight:bold;color:blue;text-decoration:overline underline
|
189
|
+
}
|
190
|
+
.hideRadio {
|
191
|
+
color:#AAAAFF;
|
192
|
+
}
|
193
|
+
.mycomment {
|
194
|
+
color:green
|
195
|
+
}
|
196
|
+
</style>
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
<table border="1" style="font-family:monospace"; font-size:10><td>
|
203
|
+
|
204
|
+
<span class="help" onMouseover="showProject()" onMouseout="notip()">Project</span> <span class="help" onMouseover="showDefaultConfig()" onMouseout="notip()">default</span>: <name> {<br>
|
205
|
+
<br>
|
206
|
+
|
207
|
+
<span class="help" onMouseover="showDescription()" onMouseout="notip()">Description</span> <text><br><br>
|
208
|
+
|
209
|
+
<span class="help" onMouseover="showVersion()" onMouseout="notip()">RequiredBakeVersion</span> minimum: <major.minor.patch>, maximum: <major.minor.patch><br><br>
|
210
|
+
|
211
|
+
<span class="help" onMouseover="showResponsible()" onMouseout="notip()">Responsible</span> {<br>
|
212
|
+
<span class="help" onMouseover="showPerson()" onMouseout="notip()">Person</span> <name>,
|
213
|
+
<span class="help" onMouseover="showPersonEmail()" onMouseout="notip()">email</span>: <adr><br>
|
214
|
+
}<br><br>
|
215
|
+
|
216
|
+
<span class="mycomment"># 0..n configs</span><br>
|
217
|
+
<span class="showRadio" onMouseover="showExecutableConfig()" onMouseout="notip()" id="executableConfig">ExecutableConfig</span> |
|
218
|
+
<span class="hideRadio" onMouseover="showLibraryConfig()" onMouseout="notip()" id="libraryConfig">LibraryConfig</span> |
|
219
|
+
<span class="hideRadio" onMouseover="showCustomConfig()" onMouseout="notip()" id="customConfig">CustomConfig</span> <name>,
|
220
|
+
<span class="help" onMouseover="showExtends()" onMouseout="notip()">extends</span>: <parent(s)>,
|
221
|
+
<span class="help" onMouseover="showPrivate()" onMouseout="notip()">private</span>: true|false {<br><br>
|
222
|
+
|
223
|
+
<span><span style="background-color:#EEEEEE;" class="show">
|
224
|
+
<span class="mycomment"># Valid for all config types</span><br><br>
|
225
|
+
<span class="help" onMouseover="showDescription()" onMouseout="notip()">Description</span> <text><br>
|
226
|
+
<span class="help" onMouseover="showIncludeDir()" onMouseout="notip()">IncludeDir</span> <dir>, <span class="help" onMouseover="showInherit()" onMouseout="notip()">inherit</span>: true|false, <span class="help" onMouseover="showInfix()" onMouseout="notip()">inject</span>: front|back, <span class="help" onMouseover="showSystemInclude()" onMouseout="notip()">system</span>: true|false<br>
|
227
|
+
<span class="help" onMouseover="showSet()" onMouseout="notip()">Set</span> <variable>, value: <value> | cmd: <line>, <span class="help" onMouseover="showEnv()" onMouseout="notip()">env</span>: true|false<br>
|
228
|
+
<span class="help" onMouseover="showDependency()" onMouseout="notip()">Dependency</span> <project>,
|
229
|
+
<span class="help" onMouseover="showDependencyConfig()" onMouseout="notip()">config</span>: <name><br>
|
230
|
+
<span class="help" onMouseover="showExternalLibrary()" onMouseout="notip()">ExternalLibrary</span> <lib>,
|
231
|
+
<span class="help" onMouseover="showExternalLibrarySearch()" onMouseout="notip()">search</span>: true|false<br>
|
232
|
+
<span class="help" onMouseover="showUserLibrary()" onMouseout="notip()">UserLibrary</span> <lib><br>
|
233
|
+
<span class="help" onMouseover="showExternalLibrarySearchPath()" onMouseout="notip()">ExternalLibrarySearchPath</span> <path><br>
|
234
|
+
<span class="help" onMouseover="showPreSteps()" onMouseout="notip()">PreSteps</span> {<br>
|
235
|
+
<span class="help" onMouseover="showMakefile()" onMouseout="notip()">Makefile</span> <file>,
|
236
|
+
<span class="help" onMouseover="showMakefileLib()" onMouseout="notip()">lib</span>: <lib>,
|
237
|
+
<span class="help" onMouseover="showMakefileTarget()" onMouseout="notip()">target</span>: <target>,
|
238
|
+
<span class="help" onMouseover="showMakefilePathTo()" onMouseout="notip()">pathTo</span>: <paths>,
|
239
|
+
<span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
|
240
|
+
<span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: <name>,
|
241
|
+
<span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
|
242
|
+
<span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: <[array]> {<br>
|
243
|
+
<span class="help" onMouseover="showMakefileFlags()" onMouseout="notip()">Flags</span> <flags><br>
|
244
|
+
}<br>
|
245
|
+
<span class="help" onMouseover="showCommandLine()" onMouseout="notip()">CommandLine</span> <line>,
|
246
|
+
<span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
|
247
|
+
<span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: <name>,
|
248
|
+
<span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
|
249
|
+
<span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: <[array]><br>
|
250
|
+
}<br>
|
251
|
+
<span class="help" onMouseover="showPostSteps()" onMouseout="notip()">PostSteps</span> {<br>
|
252
|
+
<span class="mycomment"># Same as for PreSteps</span><br>
|
253
|
+
}<br>
|
254
|
+
<span class="help" onMouseover="showStartupSteps()" onMouseout="notip()">StartupSteps</span> {<br>
|
255
|
+
<span class="mycomment"># Same as for PreSteps</span><br>
|
256
|
+
}<br>
|
257
|
+
<span class="help" onMouseover="showExitSteps()" onMouseout="notip()">ExitSteps</span> {<br>
|
258
|
+
<span class="mycomment"># Same as for PreSteps</span><br>
|
259
|
+
}<br>
|
260
|
+
<span class="help" onMouseover="showCleanSteps()" onMouseout="notip()">CleanSteps</span> {<br>
|
261
|
+
<span class="mycomment"># Same as for PreSteps</span><br>
|
262
|
+
}<br>
|
263
|
+
<span class="help" onMouseover="showDefaultToolchain()" onMouseout="notip()">DefaultToolchain</span> <basedOn>, <span class="help" onMouseover="showOutputDir()" onMouseout="notip()">outputDir</span>: <dir>, <span class="help" onMouseover="showEclipseOrder()" onMouseout="notip()">eclipseOrder</span>: true|false {<br>
|
264
|
+
<span class="help" onMouseover="showDefaultCompiler()" onMouseout="notip()">Compiler</span> ASM | CPP | C,
|
265
|
+
<span class="help" onMouseover="showCommand()" onMouseout="notip()">command</span>: <cmd> {</i><br>
|
266
|
+
<span class="help" onMouseover="showDefaultFlags()" onMouseout="notip()">Flags</span> <flags><br>
|
267
|
+
<span class="help" onMouseover="showDefaultDefine()" onMouseout="notip()">Define</span> <define><br>
|
268
|
+
<span class="help" onMouseover="showInternalDefines()" onMouseout="notip()">InternalDefines</span> <file><br>
|
269
|
+
}<br>
|
270
|
+
<span class="help" onMouseover="showDefaultArchiver()" onMouseout="notip()">Archiver</span>
|
271
|
+
<span class="help" onMouseover="showCommand()" onMouseout="notip()">command</span>: <cmd> {</i><br>
|
272
|
+
<span class="help" onMouseover="showDefaultFlags()" onMouseout="notip()">Flags</span> <flags><br>
|
273
|
+
}<br>
|
274
|
+
<span class="help" onMouseover="showDefaultLinker()" onMouseout="notip()">Linker</span>
|
275
|
+
<span class="help" onMouseover="showCommand()" onMouseout="notip()">command</span>: <cmd> {</i><br>
|
276
|
+
<span class="help" onMouseover="showDefaultFlags()" onMouseout="notip()">Flags</span> <flags><br>
|
277
|
+
<span class="help" onMouseover="showLibPrefixFlags()" onMouseout="notip()">LibPrefixFlags</span> <flags><br>
|
278
|
+
<span class="help" onMouseover="showLibPostfixFlags()" onMouseout="notip()">LibPostfixFlags</span> <flags><br>
|
279
|
+
}<br>
|
280
|
+
<span class="help" onMouseover="showInternalIncludes()" onMouseout="notip()">InternalIncludes</span> <file><br>
|
281
|
+
<span class="help" onMouseover="showDocu()" onMouseout="notip()">Docu</span> <cmdLine><br>
|
282
|
+
}<br>
|
283
|
+
|
284
|
+
|
285
|
+
<span class="help" onMouseover="showToolchainProject()" onMouseout="notip()">Toolchain</span> <span class="help" onMouseover="showOutputDir()" onMouseout="notip()">outputDir</span>: <dir> {<br>
|
286
|
+
<span class="help" onMouseover="showCompiler()" onMouseout="notip()">Compiler</span> ASM | CPP | C,
|
287
|
+
<span class="help" onMouseover="showCommand()" onMouseout="notip()">command</span>: <cmd> {</i><br>
|
288
|
+
<span class="help" onMouseover="showFlags()" onMouseout="notip()">Flags</span> <flags>, add: <flags>, remove: <flags><br>
|
289
|
+
<span class="help" onMouseover="showDefine()" onMouseout="notip()">Define</span> <define><br>
|
290
|
+
}<br>
|
291
|
+
<span class="help" onMouseover="showArchiver()" onMouseout="notip()">Archiver</span>
|
292
|
+
<span class="help" onMouseover="showCommand()" onMouseout="notip()">command</span>: <cmd> {</i><br>
|
293
|
+
<span class="help" onMouseover="showFlags()" onMouseout="notip()">Flags</span> <flags>, add: <flags>, remove: <flags><br>
|
294
|
+
}<br>
|
295
|
+
<span class="help" onMouseover="showLinker()" onMouseout="notip()">Linker</span>
|
296
|
+
<span class="help" onMouseover="showCommand()" onMouseout="notip()">command</span>: <cmd> {</i><br>
|
297
|
+
<span class="help" onMouseover="showFlags()" onMouseout="notip()">Flags</span> <flags>, add: <flags>, remove: <flags><br>
|
298
|
+
<span class="help" onMouseover="showLibPrefixFlags()" onMouseout="notip()">LibPrefixFlags</span> <flags>, add: <flags>, remove: <flags><br>
|
299
|
+
<span class="help" onMouseover="showLibPostfixFlags()" onMouseout="notip()">LibPostfixFlags</span> <flags>, add: <flags>, remove: <flags><br>
|
300
|
+
}<br>
|
301
|
+
<span class="help" onMouseover="showDocu()" onMouseout="notip()">Docu</span> <cmdLine><br>
|
302
|
+
}<br>
|
303
|
+
<span class="help" onMouseover="showPrebuild()" onMouseout="notip()">Prebuild</span> {<br>
|
304
|
+
<span class="help" onMouseover="showExcept()" onMouseout="notip()">Except</span> <project>,
|
305
|
+
<span class="help" onMouseover="showExceptConfig()" onMouseout="notip()">config</span>: <name><br>
|
306
|
+
}<br></span><br>
|
307
|
+
|
308
|
+
</span>
|
309
|
+
|
310
|
+
<span id="libExe_part"><span class="show" style="background-color:#EEEEEE;">
|
311
|
+
<span class="mycomment"># Valid for ExecutableConfig and LibraryConfig</span><br><br>
|
312
|
+
<span class="help" onMouseover="showFiles()" onMouseout="notip()">Files</span> <pattern> {<br>
|
313
|
+
<span class="help" onMouseover="showFilesFlags()" onMouseout="notip()">Flags</span> <flags>, add: <flags>, remove: <flags><br>
|
314
|
+
<span class="help" onMouseover="showFilesDefine()" onMouseout="notip()">Define</span> <define><br>
|
315
|
+
}<br>
|
316
|
+
<span class="help" onMouseover="showExcludeFiles()" onMouseout="notip()">ExcludeFiles</span> <pattern><br>
|
317
|
+
<span class="help" onMouseover="showArtifactName()" onMouseout="notip()">ArtifactName</span> <name><br>
|
318
|
+
</span><br></span>
|
319
|
+
|
320
|
+
<span id="exe_part"><span class="show" style="background-color:#EEEEEE;">
|
321
|
+
<span class="mycomment"># Valid for ExecutableConfig</span><br><br>
|
322
|
+
<span class="help" onMouseover="showLinkerScript()" onMouseout="notip()">LinkerScript</span> <script><br>
|
323
|
+
<span class="help" onMouseover="showMapFile()" onMouseout="notip()">MapFile</span> <name><br>
|
324
|
+
</span><br></span>
|
325
|
+
|
326
|
+
<span id="custom_part" class="hide"><span style="background-color:#EEEEEE;" class="show">
|
327
|
+
<span class="mycomment"># Valid for CustomConfig</span><br><br>
|
328
|
+
<span class="showRadio" id="makefile" onMouseover="showMakefileCustom()" onMouseout="notip()">Makefile</span> |
|
329
|
+
<span class="hideRadio" id="commandline" onMouseover="showCommandlineCustom()" onMouseout="notip()">CommandLine</span>
|
330
|
+
<span style="background-color:#DDDDDD;" id="makefile_part" class="showInline"> <name>,
|
331
|
+
<span class="help" onMouseover="showMakefileLib()" onMouseout="notip()">lib</span>: <lib>,
|
332
|
+
<span class="help" onMouseover="showMakefileTarget()" onMouseout="notip()">target</span>: <target>,
|
333
|
+
<span class="help" onMouseover="showMakefilePathTo()" onMouseout="notip()">pathTo</span>: <paths>,
|
334
|
+
<span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
|
335
|
+
<span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: <name>,
|
336
|
+
<span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
|
337
|
+
<span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: <[array]> {<br>
|
338
|
+
<span class="help" onMouseover="showMakefileFlags()" onMouseout="notip()">Flags</span> <flags><br>
|
339
|
+
}<br>
|
340
|
+
</span>
|
341
|
+
<span style="background-color:#DDDDDD;" id="commandline_part" class="hide"><line>,
|
342
|
+
<span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
|
343
|
+
<span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: <name>,
|
344
|
+
<span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
|
345
|
+
<span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: <[array]>
|
346
|
+
</span>
|
347
|
+
<br></span><br></span>
|
348
|
+
}<br>
|
349
|
+
}<br><br>
|
350
|
+
Adapt toolchain: <name>, os: <name>, mainProject: <name>, mainConfig: <name> {<br>
|
351
|
+
<span class="mycomment"># See Adapt documention for details.</span><br>
|
352
|
+
}<br>
|
353
|
+
|
354
|
+
|
355
|
+
<div id="dhtmltooltip"></div>
|
356
|
+
|
357
|
+
<script type="text/javascript">
|
358
|
+
|
359
|
+
|
360
|
+
function showProject() {
|
361
|
+
str = 'A bake project is very similiar to a project in Eclipse, Visual Studio, etc.<br>'+
|
362
|
+
'The name of the project is the directory name of the Project.meta file.'
|
363
|
+
ddrivetip("Project", "Yes", "1", "-",str)
|
364
|
+
}
|
365
|
+
|
366
|
+
function showDefaultConfig() {
|
367
|
+
str = 'Default configuration which is used if not explicitly specified on command line or Dependency definition.<br><br>'+
|
368
|
+
'Examples:<br>'+
|
369
|
+
'# Project.meta:<br>'+
|
370
|
+
'Dependency canDriver # uses default config of canDriver project<br>'+
|
371
|
+
'# Command line:<br>'+
|
372
|
+
'bake -m folder/dir/projABC # builds default config of project projABC'
|
373
|
+
ddrivetip("default", "No", "-", "-",str)
|
374
|
+
}
|
375
|
+
|
376
|
+
function showResponsible() {
|
377
|
+
str = "Specify all responsible persons of the project."
|
378
|
+
ddrivetip("Responsible", "No,", "0..1", "-",str)
|
379
|
+
}
|
380
|
+
|
381
|
+
function showDescription() {
|
382
|
+
str = 'Description of the project or config.'
|
383
|
+
ddrivetip("Description", "No", "0..1", "-",str)
|
384
|
+
}
|
385
|
+
|
386
|
+
function showVersion() {
|
387
|
+
str = 'If specified, the build will be aborted if bake version is lower than mininum or greater than maximum.<br>'+
|
388
|
+
'It is possible to define only minimum, only maximim or both version thresholds.<br>'+
|
389
|
+
'Minor and patch version numbers are optional.'
|
390
|
+
ddrivetip("RequiredBakeVersion", "No", "0..1", "-",str)
|
391
|
+
}
|
392
|
+
|
393
|
+
function showPerson() {
|
394
|
+
str = 'Person who is responsible for the project.'
|
395
|
+
ddrivetip("Person", "No", "0..1", "-",str)
|
396
|
+
}
|
397
|
+
|
398
|
+
function showPersonEmail() {
|
399
|
+
str = 'Use always double quotes (") for the email address.'
|
400
|
+
ddrivetip("email", "No", "-", "-",str)
|
401
|
+
}
|
402
|
+
|
403
|
+
function showExecutableConfig() {
|
404
|
+
document.getElementById('libExe_part').className="show"
|
405
|
+
document.getElementById('exe_part').className="show"
|
406
|
+
document.getElementById('custom_part').className="hide"
|
407
|
+
document.getElementById('executableConfig').className="showRadio"
|
408
|
+
document.getElementById('libraryConfig').className="hideRadio"
|
409
|
+
document.getElementById('customConfig').className="hideRadio"
|
410
|
+
|
411
|
+
str = 'This is usually the main config of an application.'
|
412
|
+
ddrivetip("ExecutableConfig", "No","0..n","-",str)
|
413
|
+
}
|
414
|
+
|
415
|
+
function showLibraryConfig() {
|
416
|
+
document.getElementById('libExe_part').className="show"
|
417
|
+
document.getElementById('exe_part').className="hide"
|
418
|
+
document.getElementById('custom_part').className="hide"
|
419
|
+
document.getElementById('executableConfig').className="hideRadio"
|
420
|
+
document.getElementById('libraryConfig').className="showRadio"
|
421
|
+
document.getElementById('customConfig').className="hideRadio"
|
422
|
+
|
423
|
+
str = 'This config is used for a source library. The library will be linked automatically to the executable.'
|
424
|
+
ddrivetip("LibraryConfig", "No","0..n","-",str)
|
425
|
+
}
|
426
|
+
|
427
|
+
function showCustomConfig() {
|
428
|
+
document.getElementById('libExe_part').className="hide"
|
429
|
+
document.getElementById('exe_part').className="hide"
|
430
|
+
document.getElementById('custom_part').className="show"
|
431
|
+
document.getElementById('executableConfig').className="hideRadio"
|
432
|
+
document.getElementById('libraryConfig').className="hideRadio"
|
433
|
+
document.getElementById('customConfig').className="showRadio"
|
434
|
+
|
435
|
+
str = 'This config is used for special projects, e.g. for Makefile projects.<br>'+
|
436
|
+
'It is valid to leave a CustomConfig completely empty - nothing will be done in that case.'
|
437
|
+
ddrivetip("CustomConfig", "No","0..n","-",str)
|
438
|
+
}
|
439
|
+
|
440
|
+
function showExternalLibrary() {
|
441
|
+
str = 'Every config can specify libs which have to be linked to the executable.<br>'+
|
442
|
+
'It\'s possible to add a path, e.g.:<br>'+
|
443
|
+
'<i> ExternalLibrary "xy/z/ab"</i><br>'+
|
444
|
+
'In this case the lib "ab" is added to the linker command line as well as the lib search path "xy/z".<br>'+
|
445
|
+
'Note, that the linker will look for "libab.a".'
|
446
|
+
ddrivetip("ExternalLibrary", "No","0..n","-",str)
|
447
|
+
}
|
448
|
+
|
449
|
+
function showExternalLibrarySearch() {
|
450
|
+
str = 'If the attribute "search: false" is specified, the lib will not be searched but linked with the full name, e.g.<br>'+
|
451
|
+
'<i> ExternalLibrary "xy/z/libpq.a", search: false</i><br>'+
|
452
|
+
'will link "xy/z/libpq.a" to the executable.<br>'+
|
453
|
+
'It is also possible to specify an object file when using "search: false".'
|
454
|
+
ddrivetip("search", "No","-","true",str)
|
455
|
+
}
|
456
|
+
|
457
|
+
function showUserLibrary() {
|
458
|
+
str = 'A user library will be linked <i>before</i> any other libraries or objects to the executable.<br>'+
|
459
|
+
'It is also possible to specify an object file.<br>'+
|
460
|
+
'The library will be searched like an ExternalLibrary, but with the full name, e.g.<br>'+
|
461
|
+
'<i> UserLibrary "xy/z/libUser.a"</i><br>'+
|
462
|
+
'<i> UserLibrary "xy/z/something.o"</i><br>'+
|
463
|
+
'will link "libUser.a" and "something.o" before regular objects and libraries.<br>'+
|
464
|
+
'"xy/z" will be added as an ExternalLibrarySearchPath.'
|
465
|
+
ddrivetip("UserLibrary", "No","0..n","-",str)
|
466
|
+
}
|
467
|
+
|
468
|
+
function showExternalLibrarySearchPath() {
|
469
|
+
str = 'The linker looks for libraries in search paths.<br>'+
|
470
|
+
'Search paths can be defined implicitly by ExternalLibrary/UserLibrary or explicitly by this tag.'
|
471
|
+
ddrivetip("ExternalLibrarySearchPath", "No","0..n","-",str)
|
472
|
+
}
|
473
|
+
|
474
|
+
function showPreSteps() {
|
475
|
+
str = 'PreSteps are executed before compiling files of the project.<br>'+
|
476
|
+
'The number of steps are not limited.<br>'+
|
477
|
+
'If a step fails, all further steps of the project will be skipped.'
|
478
|
+
ddrivetip("PreSteps", "No","0..1","-",str)
|
479
|
+
}
|
480
|
+
|
481
|
+
function showPostSteps() {
|
482
|
+
str = 'PostSteps are executed after the main task of the project, e.g. linking an executable.<br>'+
|
483
|
+
'The number of steps are not limited.<br>'+
|
484
|
+
'If a step fails, all further steps of the project will be skipped.'
|
485
|
+
ddrivetip("PostSteps", "No","0..1","-",str)
|
486
|
+
}
|
487
|
+
|
488
|
+
function showStartupSteps() {
|
489
|
+
str = 'StartupSteps of ALL projects are executed before building the first project.<br>'+
|
490
|
+
'The number of steps are not limited.'
|
491
|
+
ddrivetip("StartupSteps", "No","0..1","-",str)
|
492
|
+
}
|
493
|
+
|
494
|
+
function showExitSteps() {
|
495
|
+
str = 'ExitSteps of ALL projects are executed after building complete workspace even if the build has failed.<br>'+
|
496
|
+
'The number of steps are not limited.'
|
497
|
+
ddrivetip("ExitSteps", "No","0..1","-",str)
|
498
|
+
}
|
499
|
+
|
500
|
+
function showCleanSteps() {
|
501
|
+
str = 'CleanSteps are executed when calling bake with "-c" or "--rebuild".<br>'+
|
502
|
+
'The number of steps are not limited.<br>'+
|
503
|
+
'If a step fails, all further steps will be skipped.'
|
504
|
+
ddrivetip("CleanSteps", "No","0..1","-",str)
|
505
|
+
}
|
506
|
+
|
507
|
+
function showStepDefault() {
|
508
|
+
str = 'Specifies if a step will be executed by default.<br>'+
|
509
|
+
'Disabling a step by default is useful if the step shall not be executed every build, e.g. special steps for releasing a software or some kind of developer test steps.'
|
510
|
+
ddrivetip("default", "No","-","on",str)
|
511
|
+
}
|
512
|
+
|
513
|
+
function showEcho() {
|
514
|
+
str = 'On means the command line is shown in output, off means the command line is not shown.'
|
515
|
+
ddrivetip("echo", "No","-","on",str)
|
516
|
+
}
|
517
|
+
|
518
|
+
function showStepFilter() {
|
519
|
+
str = 'A step can be switched on or off explicitly regardless of the "default" attribute with the command line options<br>'+
|
520
|
+
'<i> --do <filter name></i><br>'+
|
521
|
+
'<i> --omit <filter name></i><br>'
|
522
|
+
ddrivetip("filter", "No","-","-",str)
|
523
|
+
}
|
524
|
+
|
525
|
+
function showValidExitCodes() {
|
526
|
+
str = 'Define it as an array, e.g.:<br>'+
|
527
|
+
'..., validExitCodes: [200,201,202]'
|
528
|
+
ddrivetip("validExitCodes", "No","-","[0]",str)
|
529
|
+
}
|
530
|
+
|
531
|
+
|
532
|
+
function getMakefileDesc() {
|
533
|
+
return 'Makefile to be started, e.g.:<br>'+
|
534
|
+
'<i> Makefile "subDir/makefile"</i><br>'
|
535
|
+
}
|
536
|
+
|
537
|
+
function showMakefile() {
|
538
|
+
ddrivetip("Makefile", "No","0..n","-",getMakefileDesc())
|
539
|
+
}
|
540
|
+
|
541
|
+
function showMakefileLib() {
|
542
|
+
str = 'If the result of the makefile is a library which shall be linked to the executable, name it here.'
|
543
|
+
ddrivetip("lib", "No","-","-",str)
|
544
|
+
}
|
545
|
+
|
546
|
+
function showMakefileTarget() {
|
547
|
+
str = 'The target of the makefile.'
|
548
|
+
ddrivetip("target", "No","-","all",str)
|
549
|
+
}
|
550
|
+
|
551
|
+
function showMakefilePathTo() {
|
552
|
+
str = 'Comma separated list, e.g. "common, abc, xy".<br>'+
|
553
|
+
'The makefile can use variables like $(PATH_TO_common). This is very useful if paths to other projects are needed in the makefile.<br>'+
|
554
|
+
'Remember that more than one workspace root can exist and a hardcoded "../common" is not reliable in that case.<br>'+
|
555
|
+
'$(PATH_TO_common) will result in the path from the parent directory of the current project to the common project without the common directory itself. '+
|
556
|
+
'So if the current project and the common project have the same parent folder, the string will be empty.<br>'+
|
557
|
+
'Example:<br>'+
|
558
|
+
'makefile: c:\\workspaceroot\\yourProject\\makefile<br>'+
|
559
|
+
'usage in makefile: gcc -I$../../$(PATH_TO_common)common/include ...<br>'+
|
560
|
+
'It\'s done like this due to compatibility reasons.'
|
561
|
+
ddrivetip("pathTo", "No","-","-",str)
|
562
|
+
}
|
563
|
+
|
564
|
+
function showMakefileFlags() {
|
565
|
+
ddrivetip("Flags", "No","0..n","-j","Additional makefile flags.")
|
566
|
+
}
|
567
|
+
|
568
|
+
function getCommandLineDesc() {
|
569
|
+
return 'A command to execute, e.g.:<br>'+
|
570
|
+
'<i> CommandLine "ddump -Ruv -y 0xFFFFF -oRelease/application.bin Release/application.elf"</i><br>'+
|
571
|
+
'<i> CommandLine "echo Hello world!"</i><br>'
|
572
|
+
}
|
573
|
+
|
574
|
+
function showCommandLine() {
|
575
|
+
ddrivetip("CommandLine", "No","0..n","-",getCommandLineDesc())
|
576
|
+
}
|
577
|
+
|
578
|
+
|
579
|
+
function showEclipseOrder() {
|
580
|
+
str = 'If not specified or false, all files are compiled in order of appearance in Project.meta. '+
|
581
|
+
'If the filename is a glob pattern, files are sorted alphabetically.<p>'+
|
582
|
+
'If true, files are compiled in alphabetical order within a folder, '+
|
583
|
+
'but the folders are sorted in reverse alphabetical order.<br>'+
|
584
|
+
'This is only used for backward compatibility.'
|
585
|
+
ddrivetip("eclipseOrder", "No","-","false",str)
|
586
|
+
}
|
587
|
+
|
588
|
+
function showOutputDir() {
|
589
|
+
str = 'Specifies the output folder.<p>'+
|
590
|
+
'Use always relative paths, not absolute paths due to portability.<p>'+
|
591
|
+
'Use always "/" and not "\\".<p>'+
|
592
|
+
'If the first part of the path is equal to a project name, it is used as a shortcut to this project root. <br>'+
|
593
|
+
'To avoid this magic, use something like this: <br>'+
|
594
|
+
'<i> IncludeDir "./abc/include"</i><br>'
|
595
|
+
ddrivetip("outputdir", "No","0..1","-",str)
|
596
|
+
}
|
597
|
+
|
598
|
+
function showExtends() {
|
599
|
+
ddrivetip("extends", "No","0..1","-","Inherit settings from parent config(s).<br>For more information see docu page 'Derive configs'.")
|
600
|
+
}
|
601
|
+
|
602
|
+
function showPrivate() {
|
603
|
+
ddrivetip("private", "No","0..1","false","If true, the config cannot be referenced directly outside of this project.")
|
604
|
+
}
|
605
|
+
|
606
|
+
function showFiles() {
|
607
|
+
str = 'Specifies the files to build.<br>'+
|
608
|
+
'It\'s valid to specify a single file, e.g.<br>'+
|
609
|
+
'<i> Files "src/abc/def.asm"</i><br>'+
|
610
|
+
'or a pattern, e.g.<br>'+
|
611
|
+
'<i> Files "*/**/.cpp"</i><br>'+
|
612
|
+
'which builds all files with the ending ".cpp" in all subdirectories.<br>'+
|
613
|
+
'Note: ".." is not allowed in the file path. All files must be located within the project.<br>'+
|
614
|
+
'Note: if patterns are used, Flags and Define are ignored.'
|
615
|
+
ddrivetip("Files", "No","0..n","-",str)
|
616
|
+
}
|
617
|
+
|
618
|
+
function showExcludeFiles() {
|
619
|
+
str = 'Used to ignore files or directories.<br>'+
|
620
|
+
'ExcludeFiles has higher priority than Files.'
|
621
|
+
ddrivetip("ExcludeFiles", "No","0..n","-",str)
|
622
|
+
}
|
623
|
+
|
624
|
+
function showIncludeDir() {
|
625
|
+
str = 'Specifies the include directories for the assembler, C and C++ compiler.<p>'+
|
626
|
+
'Use always relative paths, not absolute paths due to portability.<p>'+
|
627
|
+
'Use always "/" and not "\\".<p>'+
|
628
|
+
'It is possible to work with different workspace roots. Do not include something like this: <br>'+
|
629
|
+
'<i> IncludeDir "../abc/include"</i><br>'+
|
630
|
+
'but<br>'+
|
631
|
+
'<i> IncludeDir "abc/include"</i><br>'+
|
632
|
+
'because it may happen, that abc does not exist in the same root as the current project. The path to abc will be calculated automatically.<p>'+
|
633
|
+
'To include directories of the current project, the project name can be omitted like this:<br>'+
|
634
|
+
'<i> IncludeDir "include"</i><br>'+
|
635
|
+
'<i> IncludeDir "generated/include"</i><br>'
|
636
|
+
ddrivetip("IncludeDir", "No","0..n","-",str)
|
637
|
+
}
|
638
|
+
|
639
|
+
function showInherit() {
|
640
|
+
str = 'Inherits the include to all projects, which depend on this project.'
|
641
|
+
ddrivetip("inherit", "No","0..1","false",str)
|
642
|
+
}
|
643
|
+
|
644
|
+
function showInfix() {
|
645
|
+
str = 'Injects the include path to all childs, either at the front (e.g. for mocking code) or at the end.'
|
646
|
+
ddrivetip("inject", "No","0..1","-",str)
|
647
|
+
}
|
648
|
+
|
649
|
+
function showSystemInclude() {
|
650
|
+
str = 'If supported from the compiler, the system include flag will be used instead of the normal include flag.<br>'+
|
651
|
+
'Example: in gcc "-isystem" instead of "-I" is used.<br>'+
|
652
|
+
'Note: system include definition overrules normal include definition if both are defined.'
|
653
|
+
ddrivetip("system", "false","0..1","-",str)
|
654
|
+
}
|
655
|
+
|
656
|
+
function showSet() {
|
657
|
+
str = 'Sets a variable for this and all dependent projects.<br>'+
|
658
|
+
'The variable can be a simple value or the result of a cmd, e.g. \"cat myVar.txt\".'
|
659
|
+
ddrivetip("Set", "No","0..n","-",str)
|
660
|
+
}
|
661
|
+
|
662
|
+
function showEnv() {
|
663
|
+
str = 'Stores the variable also in system environment, which makes it available in everything which is executed by bake, e.g. in Pre- and PostSteps.'
|
664
|
+
ddrivetip("env", "No","-","false",str)
|
665
|
+
}
|
666
|
+
|
667
|
+
function showDependency() {
|
668
|
+
str = 'Specifies another project to be built before this project.<br>'+
|
669
|
+
'The archive, linker libs and search paths are imported from this project to the this project automatically.<br>'+
|
670
|
+
'If you omit the project, the current project will be used.<br>'+
|
671
|
+
'If you omit the config name, the default config will be used.<br>'+
|
672
|
+
'<b>Examples:</b><br>'+
|
673
|
+
' <i>Dependency gtest, config: lib<br>'+
|
674
|
+
' Dependency "my/folder/proj"</i>'
|
675
|
+
ddrivetip("Dependency", "No","0..n","-",str)
|
676
|
+
}
|
677
|
+
|
678
|
+
function showDependencyConfig() {
|
679
|
+
str = 'Config name of the project to build.'
|
680
|
+
ddrivetip("config", "Yes","-","-",str)
|
681
|
+
}
|
682
|
+
|
683
|
+
function showLinkerScript() {
|
684
|
+
str = 'Specifies the name including path of the linker script.'
|
685
|
+
ddrivetip("Dependency", "No","0..1","-",str)
|
686
|
+
}
|
687
|
+
|
688
|
+
function showMapFile() {
|
689
|
+
str = 'A mapfile will be written by the linker.'
|
690
|
+
ddrivetip("MapFile", "No","0..1","If name attribute is omitted: $(OutputDir)/$(ArtifactNameBase).map",str)
|
691
|
+
}
|
692
|
+
|
693
|
+
function showArtifactName() {
|
694
|
+
str = 'The artifact name inclusive file ending.<br>'+
|
695
|
+
'The artifact will be placed in the output directory.'
|
696
|
+
ddrivetip("ArtifactName","No","0..1","Executable: project name + toolchain dependent file ending. Library: 'lib' + project name + '.a'",str)
|
697
|
+
}
|
698
|
+
|
699
|
+
function showMakefileCustom() {
|
700
|
+
document.getElementById('makefile_part').className="showInline"
|
701
|
+
document.getElementById('commandline_part').className="hide"
|
702
|
+
document.getElementById('makefile').className="showRadio"
|
703
|
+
document.getElementById('commandline').className="hideRadio"
|
704
|
+
ddrivetip("Makefile", "No","0..1 - Either Makefile or CommandLine","-",getMakefileDesc())
|
705
|
+
}
|
706
|
+
|
707
|
+
function showCommandlineCustom() {
|
708
|
+
document.getElementById('makefile_part').className="hide"
|
709
|
+
document.getElementById('commandline_part').className="showInline"
|
710
|
+
document.getElementById('makefile').className="hideRadio"
|
711
|
+
document.getElementById('commandline').className="showRadio"
|
712
|
+
ddrivetip("CommandLine", "No","0..1 - Either Makefile or CommandLine","-",getCommandLineDesc())
|
713
|
+
}
|
714
|
+
|
715
|
+
function flagExample() {
|
716
|
+
return "<br>For removing flags use regular expressions which can be interpreted by ruby.<br>"+
|
717
|
+
"Regex options for start and stop string are automatically added in order to avoid substring matches.<br><br>"+
|
718
|
+
"Flag strings are always splitted at spaces and computed individually.<br><br>"+
|
719
|
+
"<b>Examples:</b><br>"+
|
720
|
+
" <i>Flags \"-x -y\"</i> overwrites the inherited flags<br><br>"+
|
721
|
+
" <i>Flags add: \"-x -y\"</i> adds -x and -y if not exist<br><br>"+
|
722
|
+
" <i>Flags remove: \"-x -y\"</i> removes -x and -y if exist<br><br>"+
|
723
|
+
" It is possible to combine the attributes like this:<br>"+
|
724
|
+
" <i>Flags remove: \"-x\", add: \"-y\"</i><br><br>"+
|
725
|
+
" To remove -g followed by any string, e.g. -g3, the command is:<br>"+
|
726
|
+
" <i>Flags remove: \"-g.*\"</i><br>"+
|
727
|
+
" An inherited flag string \"-abc -g3 -xy\" will end up in \"-abc -xy\"."
|
728
|
+
}
|
729
|
+
|
730
|
+
function showPrebuild() {
|
731
|
+
str = 'If defined, all configs of the workspace will be skipped per default. Must be actived by the commandline option "--prebuild"'
|
732
|
+
ddrivetip("Prebuild", "No","0..1","No project/config is skipped",str)
|
733
|
+
}
|
734
|
+
|
735
|
+
function showExcept() {
|
736
|
+
str = 'Defines a project which shall not be skipped. If project name is omitted, the current project is used.'
|
737
|
+
ddrivetip("Except", "No","0..n","Every project is skipped",str)
|
738
|
+
}
|
739
|
+
|
740
|
+
function showExceptConfig() {
|
741
|
+
str = 'Defines a config which shall not be skipped. If omitted, all configs of the apprpriate project are not skipped.'
|
742
|
+
ddrivetip("Toolchain", "No","0..1","Every config is skipped",str)
|
743
|
+
}
|
744
|
+
|
745
|
+
|
746
|
+
function showToolchainProject() {
|
747
|
+
str = 'Toolchain adaptions for a project.'
|
748
|
+
ddrivetip("Toolchain", "No","0..1","The DefaultToolchain settings from the main project",str)
|
749
|
+
}
|
750
|
+
|
751
|
+
function showDefaultToolchain() {
|
752
|
+
str = 'Settings which are valid for all projects and files unless they will be overwritten.<br>'+
|
753
|
+
'The attribute "basedOn" specifies the basic toolchain configuration provided by bake, e.g. "GCC", "Diab", etc.'
|
754
|
+
ddrivetip("DefaultToolchain", "In main project","0..1","-",str)
|
755
|
+
}
|
756
|
+
|
757
|
+
function showFilesFlags() {
|
758
|
+
ddrivetip("Flags", "No","0..n","Flags from project","Flags from the project can be overwritten, extended or (partly) removed.<br>"+flagExample())
|
759
|
+
}
|
760
|
+
|
761
|
+
function showFilesDefine() {
|
762
|
+
ddrivetip("Define", "No","0..n","-","Defines which are valid only for a specific file.")
|
763
|
+
}
|
764
|
+
|
765
|
+
function showFlags() {
|
766
|
+
ddrivetip("Flags", "No","0..n","Flags from DefaultToolchain","Flags from the DefaultToolchain can be overwritten, extended or (partly) removed.<br>"+flagExample())
|
767
|
+
}
|
768
|
+
|
769
|
+
function showDefine() {
|
770
|
+
ddrivetip("Define", "No","0..n","-","Defines valid for all files in the project.")
|
771
|
+
}
|
772
|
+
|
773
|
+
function showLibPrefixFlags() {
|
774
|
+
ddrivetip("LibPrefixFlags", "No","0..n","-","Linker libs can be prefixed if needed, e.g. with \"-Wl,--whole-archive\".")
|
775
|
+
}
|
776
|
+
|
777
|
+
function showLibPostfixFlags() {
|
778
|
+
ddrivetip("LibPostfixFlags", "No","0..n","-","Linker libs can be postfixed if needed, e.g. with \"-Wl,--no-whole-archive\".")
|
779
|
+
}
|
780
|
+
|
781
|
+
function showCompiler() {
|
782
|
+
ddrivetip("Compiler", "No","0..3 (for each compiler type: ASM, CPP, C)","-","Flags and defines can be specified independently for each compiler type.")
|
783
|
+
}
|
784
|
+
|
785
|
+
function showArchiver() {
|
786
|
+
ddrivetip("Archiver", "No","0..1","-","Settings for the archiver.")
|
787
|
+
}
|
788
|
+
|
789
|
+
function showLinker() {
|
790
|
+
ddrivetip("Linker", "No","0..1","-","Makes sense only for ExecutableConfigs.")
|
791
|
+
}
|
792
|
+
|
793
|
+
function showDocu() {
|
794
|
+
ddrivetip("Docu", "No","0..1","-","Command to build the documentation. e.g.:<br>doxygen main.cfg")
|
795
|
+
}
|
796
|
+
|
797
|
+
function showDefaultFlags() {
|
798
|
+
ddrivetip("Flags", "No","0..n","-","Default flags.")
|
799
|
+
}
|
800
|
+
|
801
|
+
function showDefaultDefine() {
|
802
|
+
ddrivetip("Define", "No","0..n","-","Defines which are valid for all files.")
|
803
|
+
}
|
804
|
+
|
805
|
+
function showInternalDefines() {
|
806
|
+
ddrivetip("InternalDefines", "No","0..1","-","File with list of compiler internal defines.<br>One define per line.<br>Empty lines and comments with # are allowed.")
|
807
|
+
}
|
808
|
+
|
809
|
+
function showInternalIncludes() {
|
810
|
+
ddrivetip("InternalIncludes", "No","0..1","-","File with list of compiler internal include folders.<br>One folder per line.<br>Empty lines and comments with # are allowed.")
|
811
|
+
}
|
812
|
+
|
813
|
+
function showDefaultCompiler() {
|
814
|
+
ddrivetip("Compiler", "No","0..3 (for each compiler type: ASM, CPP, C)","-","Default compiler settings.")
|
815
|
+
}
|
816
|
+
|
817
|
+
function showDefaultArchiver() {
|
818
|
+
ddrivetip("Archiver", "No","0..1","-","Default settings for the archiver.")
|
819
|
+
}
|
820
|
+
|
821
|
+
function showDefaultLinker() {
|
822
|
+
ddrivetip("Linker", "No","0..1","-","Default settings for the linker.")
|
823
|
+
}
|
824
|
+
|
825
|
+
function showCommand() {
|
826
|
+
ddrivetip("command", "No","-","Depending on toolchain, e.g. \"gcc\"","Change command, e.g. \"$(PATH_TO_EXE)/gcc_speciale.exe\"")
|
827
|
+
}
|
828
|
+
|
829
|
+
|
830
|
+
|
831
|
+
var offsetxpoint=20 //Customize x offset of tooltip
|
832
|
+
var offsetypoint=20 //Customize y offset of tooltip
|
833
|
+
var ie=document.all
|
834
|
+
var ns6=document.getElementById && !document.all
|
835
|
+
var enabletip=false
|
836
|
+
if (ie||ns6)
|
837
|
+
var tipobj=document.all? document.all["dhtmltooltip"] : document.getElementById? document.getElementById("dhtmltooltip") : ""
|
838
|
+
|
839
|
+
function ietruebody(){
|
840
|
+
return (document.compatMode && document.compatMode!="BackCompat")? document.documentElement : document.body
|
841
|
+
}
|
842
|
+
|
843
|
+
function ddrivetip(item, manda, quan, def, desc){
|
844
|
+
if (ns6||ie){
|
845
|
+
|
846
|
+
var abc=ie&&!window.opera? ietruebody().clientWidth : window.innerWidth
|
847
|
+
|
848
|
+
tipobj.style.width=(abc/2-offsetxpoint*2).toString()+"px"
|
849
|
+
tipobj.style.backgroundColor="#DDFFDD"
|
850
|
+
tipobj.innerHTML="<b><u>"+item+"</u><br><br>Mandatory:</b> "+manda+"<br><b>Quantity</b>: "+quan+"<br><b>Default</b>: "+def+"<br><br><b>Description</b>:<br>"+desc
|
851
|
+
enabletip=true
|
852
|
+
return false
|
853
|
+
}
|
854
|
+
}
|
855
|
+
|
856
|
+
function positiontip(e){
|
857
|
+
if (enabletip){
|
858
|
+
var curX=(ns6)?e.offsetX : event.clientX+ietruebody().scrollLeft;
|
859
|
+
var curY=(ns6)?e.pageY-80 : event.clientY+ietruebody().scrollTop;
|
860
|
+
//Find out how close the mouse is to the corner of the window
|
861
|
+
var rightedge=ie&&!window.opera? ietruebody().clientWidth-event.clientX-offsetxpoint : window.innerWidth-e.clientX-offsetxpoint
|
862
|
+
var bottomedge=ie&&!window.opera? ietruebody().clientHeight-event.clientY-offsetypoint*2 : window.innerHeight-e.clientY-offsetypoint
|
863
|
+
var bottom=ie&&!window.opera? ietruebody().clientHeight : window.innerHeight
|
864
|
+
|
865
|
+
var leftedge=(offsetxpoint<0)? offsetxpoint*(-1) : offsetxpoint
|
866
|
+
|
867
|
+
//if the horizontal distance isn't enough to accomodate the width of the context menu
|
868
|
+
if (rightedge<tipobj.offsetWidth+offsetxpoint/2)
|
869
|
+
//move the horizontal position of the menu to the left by it's width
|
870
|
+
tipobj.style.left=ie? ietruebody().scrollLeft+event.clientX-tipobj.offsetWidth-offsetxpoint+"px" : window.pageXOffset+e.clientX-tipobj.offsetWidth-offsetxpoint+"px"
|
871
|
+
else if (curX<leftedge)
|
872
|
+
tipobj.style.left="5px"
|
873
|
+
else
|
874
|
+
//position the horizontal position of the menu where the mouse is positioned
|
875
|
+
tipobj.style.left=curX+offsetxpoint+"px"
|
876
|
+
|
877
|
+
//same concept with the vertical position
|
878
|
+
if (bottomedge<tipobj.offsetHeight)
|
879
|
+
tipobj.style.top=ie? ietruebody().scrollTop+bottom-tipobj.offsetHeight-offsetypoint+"px" : window.pageYOffset+bottom-tipobj.offsetHeight-offsetypoint+"px"
|
880
|
+
else
|
881
|
+
tipobj.style.top=curY+offsetypoint+"px"
|
882
|
+
tipobj.style.visibility="visible"
|
883
|
+
}
|
884
|
+
}
|
885
|
+
|
886
|
+
|
887
|
+
function notip(){
|
888
|
+
if (ns6||ie){
|
889
|
+
enabletip=false
|
890
|
+
tipobj.style.visibility="hidden"
|
891
|
+
tipobj.style.left="-1000px"
|
892
|
+
tipobj.style.backgroundColor=''
|
893
|
+
tipobj.style.width=''
|
894
|
+
}
|
895
|
+
}
|
896
|
+
|
897
|
+
document.onmousemove=positiontip
|
898
|
+
|
899
|
+
</script>
|
900
|
+
|
901
|
+
</td></table>
|
902
|
+
|
903
|
+
</body>
|
904
|
+
</html>
|
905
|
+
<div class="admonition note">
|
906
|
+
<p class="first admonition-title">Note</p>
|
907
|
+
<p>Specify the paths always relative to the current project root, but keep the variable substitution in Project.meta in mind.</p>
|
908
|
+
<ul class="last simple">
|
909
|
+
<li>Use double quotes (”) if the strings have spaces or slashes.</li>
|
910
|
+
<li>Use hash marks (#) for comments.</li>
|
911
|
+
</ul>
|
912
|
+
</div>
|
913
|
+
</div>
|
914
|
+
</div>
|
915
|
+
|
916
|
+
|
917
|
+
</div>
|
918
|
+
|
919
|
+
</div>
|
920
|
+
</div>
|
921
|
+
<footer class="footer">
|
922
|
+
<div class="container">
|
923
|
+
<p class="pull-right">
|
924
|
+
<a href="#">Back to top</a>
|
925
|
+
|
926
|
+
</p>
|
927
|
+
<p>
|
928
|
+
© Copyright 2016, E.S.R.Labs AG.<br/>
|
929
|
+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
|
930
|
+
</p>
|
931
|
+
</div>
|
932
|
+
</footer>
|
933
|
+
</body>
|
924
934
|
</html>
|