bake-toolkit 2.19.0 → 2.19.1

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.
Files changed (106) hide show
  1. checksums.yaml +4 -4
  2. data/documentation/_build/html/_sources/changelog.txt +3 -0
  3. data/documentation/_build/html/_sources/concepts/build_hierarchy.txt +34 -0
  4. data/documentation/_build/html/_sources/index.txt +1 -1
  5. data/documentation/_build/html/_static/basic.css +598 -598
  6. data/documentation/_build/html/_static/bootstrap-2.3.2/css/bootstrap-responsive.css +1109 -1109
  7. data/documentation/_build/html/_static/bootstrap-2.3.2/css/bootstrap-responsive.min.css +9 -9
  8. data/documentation/_build/html/_static/bootstrap-2.3.2/css/bootstrap.css +6167 -6167
  9. data/documentation/_build/html/_static/bootstrap-2.3.2/css/bootstrap.min.css +9 -9
  10. data/documentation/_build/html/_static/bootstrap-2.3.2/js/bootstrap.js +2287 -2287
  11. data/documentation/_build/html/_static/bootstrap-2.3.2/js/bootstrap.min.js +5 -5
  12. data/documentation/_build/html/_static/bootstrap-3.3.4/css/bootstrap-theme.css +476 -476
  13. data/documentation/_build/html/_static/bootstrap-3.3.4/css/bootstrap-theme.min.css +4 -4
  14. data/documentation/_build/html/_static/bootstrap-3.3.4/css/bootstrap.css +6584 -6584
  15. data/documentation/_build/html/_static/bootstrap-3.3.4/css/bootstrap.min.css +4 -4
  16. data/documentation/_build/html/_static/bootstrap-3.3.4/fonts/glyphicons-halflings-regular.svg +287 -287
  17. data/documentation/_build/html/_static/bootstrap-3.3.4/js/bootstrap.js +2317 -2317
  18. data/documentation/_build/html/_static/bootstrap-3.3.4/js/bootstrap.min.js +6 -6
  19. data/documentation/_build/html/_static/bootstrap-3.3.4/js/npm.js +12 -12
  20. data/documentation/_build/html/_static/bootstrap-sphinx.css +186 -186
  21. data/documentation/_build/html/_static/bootstrap-sphinx.js +161 -161
  22. data/documentation/_build/html/_static/bootswatch-2.3.2/amelia/bootstrap.min.css +9 -9
  23. data/documentation/_build/html/_static/bootswatch-2.3.2/cerulean/bootstrap.min.css +9 -9
  24. data/documentation/_build/html/_static/bootswatch-2.3.2/cosmo/bootstrap.min.css +9 -9
  25. data/documentation/_build/html/_static/bootswatch-2.3.2/cyborg/bootstrap.min.css +9 -9
  26. data/documentation/_build/html/_static/bootswatch-2.3.2/flatly/bootstrap.min.css +9 -9
  27. data/documentation/_build/html/_static/bootswatch-2.3.2/journal/bootstrap.min.css +9 -9
  28. data/documentation/_build/html/_static/bootswatch-2.3.2/readable/bootstrap.min.css +9 -9
  29. data/documentation/_build/html/_static/bootswatch-2.3.2/simplex/bootstrap.min.css +9 -9
  30. data/documentation/_build/html/_static/bootswatch-2.3.2/slate/bootstrap.min.css +9 -9
  31. data/documentation/_build/html/_static/bootswatch-2.3.2/spacelab/bootstrap.min.css +9 -9
  32. data/documentation/_build/html/_static/bootswatch-2.3.2/spruce/bootstrap.min.css +9 -9
  33. data/documentation/_build/html/_static/bootswatch-2.3.2/superhero/bootstrap.min.css +9 -9
  34. data/documentation/_build/html/_static/bootswatch-2.3.2/united/bootstrap.min.css +9 -9
  35. data/documentation/_build/html/_static/bootswatch-3.3.4/cerulean/bootstrap.min.css +6 -6
  36. data/documentation/_build/html/_static/bootswatch-3.3.4/cosmo/bootstrap.min.css +6 -6
  37. data/documentation/_build/html/_static/bootswatch-3.3.4/custom/bootstrap.min.css +6 -6
  38. data/documentation/_build/html/_static/bootswatch-3.3.4/cyborg/bootstrap.min.css +6 -6
  39. data/documentation/_build/html/_static/bootswatch-3.3.4/darkly/bootstrap.min.css +6 -6
  40. data/documentation/_build/html/_static/bootswatch-3.3.4/flatly/bootstrap.min.css +6 -6
  41. data/documentation/_build/html/_static/bootswatch-3.3.4/fonts/glyphicons-halflings-regular.svg +287 -287
  42. data/documentation/_build/html/_static/bootswatch-3.3.4/journal/bootstrap.min.css +6 -6
  43. data/documentation/_build/html/_static/bootswatch-3.3.4/lumen/bootstrap.min.css +6 -6
  44. data/documentation/_build/html/_static/bootswatch-3.3.4/paper/bootstrap.min.css +6 -6
  45. data/documentation/_build/html/_static/bootswatch-3.3.4/readable/bootstrap.min.css +6 -6
  46. data/documentation/_build/html/_static/bootswatch-3.3.4/sandstone/bootstrap.min.css +6 -6
  47. data/documentation/_build/html/_static/bootswatch-3.3.4/simplex/bootstrap.min.css +6 -6
  48. data/documentation/_build/html/_static/bootswatch-3.3.4/slate/bootstrap.min.css +6 -6
  49. data/documentation/_build/html/_static/bootswatch-3.3.4/spacelab/bootstrap.min.css +6 -6
  50. data/documentation/_build/html/_static/bootswatch-3.3.4/superhero/bootstrap.min.css +6 -6
  51. data/documentation/_build/html/_static/bootswatch-3.3.4/united/bootstrap.min.css +6 -6
  52. data/documentation/_build/html/_static/bootswatch-3.3.4/yeti/bootstrap.min.css +6 -6
  53. data/documentation/_build/html/_static/doctools.js +263 -263
  54. data/documentation/_build/html/_static/jquery-1.11.1.js +10308 -10308
  55. data/documentation/_build/html/_static/jquery.js +4 -4
  56. data/documentation/_build/html/_static/js/jquery-1.11.0.min.js +4 -4
  57. data/documentation/_build/html/_static/js/jquery-fix.js +1 -1
  58. data/documentation/_build/html/_static/searchtools.js +621 -621
  59. data/documentation/_build/html/_static/underscore-1.3.1.js +999 -999
  60. data/documentation/_build/html/_static/underscore.js +31 -31
  61. data/documentation/_build/html/_static/websupport.js +808 -808
  62. data/documentation/_build/html/changelog.html +949 -944
  63. data/documentation/_build/html/commandline/commandline.html +284 -284
  64. data/documentation/_build/html/concepts/build_hierarchy.html +205 -0
  65. data/documentation/_build/html/concepts/concepts.html +186 -186
  66. data/documentation/_build/html/concepts/link_order.html +245 -245
  67. data/documentation/_build/html/concepts/the_main_project.html +260 -260
  68. data/documentation/_build/html/concepts/the_project_meta_file.html +288 -288
  69. data/documentation/_build/html/genindex.html +152 -152
  70. data/documentation/_build/html/ide/eclipse/eclipse.html +186 -186
  71. data/documentation/_build/html/ide/eclipse/how_to_convert_existing_cdt_workspace.html +208 -208
  72. data/documentation/_build/html/ide/eclipse/how_to_create_a_new_project_in_eclipse.html +191 -191
  73. data/documentation/_build/html/ide/eclipse/how_to_create_a_workspace_in_eclipse.html +198 -198
  74. data/documentation/_build/html/ide/eclipse/how_to_debug_in_eclipse.html +198 -198
  75. data/documentation/_build/html/ide/eclipse/how_to_install_eclipse_plugin.html +196 -196
  76. data/documentation/_build/html/ide/eclipse/how_to_use_bake_in_eclipse.html +256 -256
  77. data/documentation/_build/html/ide/ide_integrations.html +183 -183
  78. data/documentation/_build/html/ide/vs/how_to_create_vs_projects.html +171 -171
  79. data/documentation/_build/html/ide/vs/how_to_debug_in_vs.html +185 -185
  80. data/documentation/_build/html/ide/vs/how_to_used_bake_in_vs.html +190 -190
  81. data/documentation/_build/html/ide/vs/vs.html +170 -170
  82. data/documentation/_build/html/ide/vs/vs_install.html +202 -202
  83. data/documentation/_build/html/index.html +241 -241
  84. data/documentation/_build/html/install/install_bake.html +279 -279
  85. data/documentation/_build/html/internal.html +217 -217
  86. data/documentation/_build/html/known_issues.html +175 -175
  87. data/documentation/_build/html/license.html +236 -236
  88. data/documentation/_build/html/performance/performance.html +373 -373
  89. data/documentation/_build/html/quickstart/quickstart.html +236 -236
  90. data/documentation/_build/html/search.html +174 -174
  91. data/documentation/_build/html/searchindex.js +1 -1
  92. data/documentation/_build/html/syntax/adapt_configs.html +286 -286
  93. data/documentation/_build/html/syntax/derive_configs.html +247 -247
  94. data/documentation/_build/html/syntax/project_meta_syntax.html +893 -893
  95. data/documentation/_build/html/syntax/syntax.html +189 -189
  96. data/documentation/_build/html/syntax/variable_substitutions.html +378 -378
  97. data/documentation/_build/html/tips_and_tricks/bundle.html +180 -180
  98. data/documentation/_build/html/tips_and_tricks/how_to_use_bake_with_cygwin.html +214 -214
  99. data/documentation/_build/html/tips_and_tricks/static_code_analysis.html +284 -284
  100. data/documentation/_build/html/tips_and_tricks/the_bakery.html +405 -405
  101. data/documentation/_build/html/tips_and_tricks/the_clang.html +201 -201
  102. data/documentation/_build/html/tips_and_tricks/tips_and_tricks.html +197 -197
  103. data/documentation/_build/html/why_bake/why_bake.html +241 -241
  104. data/lib/blocks/block.rb +9 -4
  105. data/lib/common/version.rb +1 -1
  106. metadata +4 -2
@@ -1,190 +1,190 @@
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>Syntax &mdash; bake 2.19.0 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: '2.19.0',
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 2.19.0 documentation" href="../index.html" />
33
- <link rel="next" title="The Syntax of the Project.meta file" href="project_meta_syntax.html" />
34
- <link rel="prev" title="The link order" href="../concepts/link_order.html" />
35
- <meta charset='utf-8'>
36
- <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
37
- <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
38
- <meta name="apple-mobile-web-app-capable" content="yes">
39
-
40
- </head>
41
- <body role="document">
42
-
43
- <div id="navbar" class="navbar navbar-default navbar-fixed-top">
44
- <div class="container">
45
- <div class="navbar-header">
46
- <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
47
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
48
- <span class="icon-bar"></span>
49
- <span class="icon-bar"></span>
50
- <span class="icon-bar"></span>
51
- </button>
52
- <a class="navbar-brand" href="../index.html"><img src="../_static/logo_conformant_48.png">
53
- </a>
54
- <span class="navbar-text navbar-version pull-left"><b></b></span>
55
- </div>
56
-
57
- <div class="collapse navbar-collapse nav-collapse">
58
- <ul class="nav navbar-nav">
59
-
60
-
61
- <li class="dropdown globaltoc-container">
62
- <a role="button"
63
- id="dLabelGlobalToc"
64
- data-toggle="dropdown"
65
- data-target="#"
66
- href="../index.html">Section <b class="caret"></b></a>
67
- <ul class="dropdown-menu globaltoc"
68
- role="menu"
69
- aria-labelledby="dLabelGlobalToc"><ul class="current">
70
- <li class="toctree-l1"><a class="reference internal" href="../why_bake/why_bake.html">Why you should use bake</a></li>
71
- <li class="toctree-l1"><a class="reference internal" href="../install/install_bake.html">Install bake</a></li>
72
- <li class="toctree-l1"><a class="reference internal" href="../quickstart/quickstart.html">Quickstart</a></li>
73
- <li class="toctree-l1"><a class="reference internal" href="../concepts/concepts.html">Concepts</a></li>
74
- <li class="toctree-l1 current"><a class="current reference internal" href="">Syntax</a></li>
75
- <li class="toctree-l1"><a class="reference internal" href="../commandline/commandline.html">Commandline</a></li>
76
- <li class="toctree-l1"><a class="reference internal" href="../ide/ide_integrations.html">IDE Support</a></li>
77
- <li class="toctree-l1"><a class="reference internal" href="../tips_and_tricks/tips_and_tricks.html">Tips and Tricks</a></li>
78
- <li class="toctree-l1"><a class="reference internal" href="../performance/performance.html">Performance</a></li>
79
- <li class="toctree-l1"><a class="reference internal" href="../known_issues.html">Known Issues</a></li>
80
- <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
81
- <li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
82
- </ul>
83
- <ul>
84
- <li class="toctree-l1"><a class="reference internal" href="../internal.html">Internal developing notes</a></li>
85
- </ul>
86
- </ul>
87
- </li>
88
-
89
- <li class="dropdown">
90
- <a role="button"
91
- id="dLabelLocalToc"
92
- data-toggle="dropdown"
93
- data-target="#"
94
- href="#">SubSections <b class="caret"></b></a>
95
- <ul class="dropdown-menu localtoc"
96
- role="menu"
97
- aria-labelledby="dLabelLocalToc"><ul>
98
- <li><a class="reference internal" href="#">Syntax</a></li>
99
- </ul>
100
- </ul>
101
- </li>
102
-
103
-
104
-
105
-
106
-
107
- <li>
108
- <a href="../concepts/link_order.html" title="Previous Chapter: The link order"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; The link order</span>
109
- </a>
110
- </li>
111
- <li>
112
- <a href="project_meta_syntax.html" title="Next Chapter: The Syntax of the Project.meta file"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">The Syntax of... &raquo;</span>
113
- </a>
114
- </li>
115
-
116
-
117
-
118
-
119
-
120
- </ul>
121
-
122
-
123
-
124
- <form class="navbar-form navbar-right" action="../search.html" method="get">
125
- <div class="form-group">
126
- <input type="text" name="q" class="form-control" placeholder="Search" />
127
- </div>
128
- <input type="hidden" name="check_keywords" value="yes" />
129
- <input type="hidden" name="area" value="default" />
130
- </form>
131
-
132
- </div>
133
- </div>
134
- </div>
135
-
136
- <div class="container">
137
- <div class="row">
138
- <div class="col-md-12">
139
-
140
- <div class="section" id="syntax">
141
- <h1>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h1>
142
- <div class="toctree-wrapper compound">
143
- <ul>
144
- <li class="toctree-l1"><a class="reference internal" href="project_meta_syntax.html">The Syntax of the Project.meta file</a><ul>
145
- <li class="toctree-l2"><a class="reference internal" href="project_meta_syntax.html#instructions-for-the-interactive-syntax-viewer">Instructions for the Interactive Syntax Viewer</a></li>
146
- </ul>
147
- </li>
148
- <li class="toctree-l1"><a class="reference internal" href="variable_substitutions.html">Variables in Project.meta</a><ul>
149
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#user-defined-variables">User defined variables</a></li>
150
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#pre-defined-bake-environment-variables">Pre defined bake environment variables</a></li>
151
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#nested-variables">Nested variables</a></li>
152
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#auto-adjustment-of-paths-to-existing-projects">Auto-adjustment of paths to existing projects</a></li>
153
- </ul>
154
- </li>
155
- <li class="toctree-l1"><a class="reference internal" href="derive_configs.html">Derive configs</a><ul>
156
- <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#deriving-a-config">Deriving a config</a></li>
157
- <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#inheritance-implications">Inheritance implications</a></li>
158
- <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#multiple-inheritance">Multiple inheritance</a></li>
159
- </ul>
160
- </li>
161
- <li class="toctree-l1"><a class="reference internal" href="adapt_configs.html">Adapt configs</a><ul>
162
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#introduction">Introduction</a></li>
163
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#effectiveness">Effectiveness</a></li>
164
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#occurrences">Occurrences</a></li>
165
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#types">Types</a></li>
166
- </ul>
167
- </li>
168
- </ul>
169
- </div>
170
- </div>
171
-
172
-
173
- </div>
174
-
175
- </div>
176
- </div>
177
- <footer class="footer">
178
- <div class="container">
179
- <p class="pull-right">
180
- <a href="#">Back to top</a>
181
-
182
- </p>
183
- <p>
184
- &copy; Copyright 2016, E.S.R.Labs AG.<br/>
185
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
186
- </p>
187
- </div>
188
- </footer>
189
- </body>
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>Syntax &mdash; bake 2.19.1 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: '2.19.1',
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 2.19.1 documentation" href="../index.html" />
33
+ <link rel="next" title="The Syntax of the Project.meta file" href="project_meta_syntax.html" />
34
+ <link rel="prev" title="The link order" href="../concepts/link_order.html" />
35
+ <meta charset='utf-8'>
36
+ <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
37
+ <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
38
+ <meta name="apple-mobile-web-app-capable" content="yes">
39
+
40
+ </head>
41
+ <body role="document">
42
+
43
+ <div id="navbar" class="navbar navbar-default navbar-fixed-top">
44
+ <div class="container">
45
+ <div class="navbar-header">
46
+ <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
47
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
48
+ <span class="icon-bar"></span>
49
+ <span class="icon-bar"></span>
50
+ <span class="icon-bar"></span>
51
+ </button>
52
+ <a class="navbar-brand" href="../index.html"><img src="../_static/logo_conformant_48.png">
53
+ </a>
54
+ <span class="navbar-text navbar-version pull-left"><b></b></span>
55
+ </div>
56
+
57
+ <div class="collapse navbar-collapse nav-collapse">
58
+ <ul class="nav navbar-nav">
59
+
60
+
61
+ <li class="dropdown globaltoc-container">
62
+ <a role="button"
63
+ id="dLabelGlobalToc"
64
+ data-toggle="dropdown"
65
+ data-target="#"
66
+ href="../index.html">Section <b class="caret"></b></a>
67
+ <ul class="dropdown-menu globaltoc"
68
+ role="menu"
69
+ aria-labelledby="dLabelGlobalToc"><ul class="current">
70
+ <li class="toctree-l1"><a class="reference internal" href="../why_bake/why_bake.html">Why you should use bake</a></li>
71
+ <li class="toctree-l1"><a class="reference internal" href="../install/install_bake.html">Install bake</a></li>
72
+ <li class="toctree-l1"><a class="reference internal" href="../quickstart/quickstart.html">Quickstart</a></li>
73
+ <li class="toctree-l1"><a class="reference internal" href="../concepts/concepts.html">Concepts</a></li>
74
+ <li class="toctree-l1 current"><a class="current reference internal" href="">Syntax</a></li>
75
+ <li class="toctree-l1"><a class="reference internal" href="../commandline/commandline.html">Commandline</a></li>
76
+ <li class="toctree-l1"><a class="reference internal" href="../ide/ide_integrations.html">IDE Support</a></li>
77
+ <li class="toctree-l1"><a class="reference internal" href="../tips_and_tricks/tips_and_tricks.html">Tips and Tricks</a></li>
78
+ <li class="toctree-l1"><a class="reference internal" href="../performance/performance.html">Performance</a></li>
79
+ <li class="toctree-l1"><a class="reference internal" href="../known_issues.html">Known Issues</a></li>
80
+ <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
81
+ <li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
82
+ </ul>
83
+ <ul>
84
+ <li class="toctree-l1"><a class="reference internal" href="../internal.html">Internal developing notes</a></li>
85
+ </ul>
86
+ </ul>
87
+ </li>
88
+
89
+ <li class="dropdown">
90
+ <a role="button"
91
+ id="dLabelLocalToc"
92
+ data-toggle="dropdown"
93
+ data-target="#"
94
+ href="#">SubSections <b class="caret"></b></a>
95
+ <ul class="dropdown-menu localtoc"
96
+ role="menu"
97
+ aria-labelledby="dLabelLocalToc"><ul>
98
+ <li><a class="reference internal" href="#">Syntax</a></li>
99
+ </ul>
100
+ </ul>
101
+ </li>
102
+
103
+
104
+
105
+
106
+
107
+ <li>
108
+ <a href="../concepts/link_order.html" title="Previous Chapter: The link order"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; The link order</span>
109
+ </a>
110
+ </li>
111
+ <li>
112
+ <a href="project_meta_syntax.html" title="Next Chapter: The Syntax of the Project.meta file"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">The Syntax of... &raquo;</span>
113
+ </a>
114
+ </li>
115
+
116
+
117
+
118
+
119
+
120
+ </ul>
121
+
122
+
123
+
124
+ <form class="navbar-form navbar-right" action="../search.html" method="get">
125
+ <div class="form-group">
126
+ <input type="text" name="q" class="form-control" placeholder="Search" />
127
+ </div>
128
+ <input type="hidden" name="check_keywords" value="yes" />
129
+ <input type="hidden" name="area" value="default" />
130
+ </form>
131
+
132
+ </div>
133
+ </div>
134
+ </div>
135
+
136
+ <div class="container">
137
+ <div class="row">
138
+ <div class="col-md-12">
139
+
140
+ <div class="section" id="syntax">
141
+ <h1>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h1>
142
+ <div class="toctree-wrapper compound">
143
+ <ul>
144
+ <li class="toctree-l1"><a class="reference internal" href="project_meta_syntax.html">The Syntax of the Project.meta file</a><ul>
145
+ <li class="toctree-l2"><a class="reference internal" href="project_meta_syntax.html#instructions-for-the-interactive-syntax-viewer">Instructions for the Interactive Syntax Viewer</a></li>
146
+ </ul>
147
+ </li>
148
+ <li class="toctree-l1"><a class="reference internal" href="variable_substitutions.html">Variables in Project.meta</a><ul>
149
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#user-defined-variables">User defined variables</a></li>
150
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#pre-defined-bake-environment-variables">Pre defined bake environment variables</a></li>
151
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#nested-variables">Nested variables</a></li>
152
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#auto-adjustment-of-paths-to-existing-projects">Auto-adjustment of paths to existing projects</a></li>
153
+ </ul>
154
+ </li>
155
+ <li class="toctree-l1"><a class="reference internal" href="derive_configs.html">Derive configs</a><ul>
156
+ <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#deriving-a-config">Deriving a config</a></li>
157
+ <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#inheritance-implications">Inheritance implications</a></li>
158
+ <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#multiple-inheritance">Multiple inheritance</a></li>
159
+ </ul>
160
+ </li>
161
+ <li class="toctree-l1"><a class="reference internal" href="adapt_configs.html">Adapt configs</a><ul>
162
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#introduction">Introduction</a></li>
163
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#effectiveness">Effectiveness</a></li>
164
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#occurrences">Occurrences</a></li>
165
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#types">Types</a></li>
166
+ </ul>
167
+ </li>
168
+ </ul>
169
+ </div>
170
+ </div>
171
+
172
+
173
+ </div>
174
+
175
+ </div>
176
+ </div>
177
+ <footer class="footer">
178
+ <div class="container">
179
+ <p class="pull-right">
180
+ <a href="#">Back to top</a>
181
+
182
+ </p>
183
+ <p>
184
+ &copy; Copyright 2016, E.S.R.Labs AG.<br/>
185
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
186
+ </p>
187
+ </div>
188
+ </footer>
189
+ </body>
190
190
  </html>
@@ -1,379 +1,379 @@
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>Variables in Project.meta &mdash; bake 2.19.0 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: '2.19.0',
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 2.19.0 documentation" href="../index.html" />
33
- <link rel="up" title="Syntax" href="syntax.html" />
34
- <link rel="next" title="Derive configs" href="derive_configs.html" />
35
- <link rel="prev" title="The Syntax of the Project.meta file" href="project_meta_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_conformant_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">Tips and Tricks</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="#">Variables in Project.meta</a><ul>
100
- <li><a class="reference internal" href="#user-defined-variables">User defined variables</a></li>
101
- <li><a class="reference internal" href="#pre-defined-bake-environment-variables">Pre defined bake environment variables</a></li>
102
- <li><a class="reference internal" href="#nested-variables">Nested variables</a></li>
103
- <li><a class="reference internal" href="#auto-adjustment-of-paths-to-existing-projects">Auto-adjustment of paths to existing projects</a></li>
104
- </ul>
105
- </li>
106
- </ul>
107
- </ul>
108
- </li>
109
-
110
-
111
-
112
-
113
-
114
- <li>
115
- <a href="project_meta_syntax.html" title="Previous Chapter: The Syntax of the Project.meta file"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; The Syntax of...</span>
116
- </a>
117
- </li>
118
- <li>
119
- <a href="derive_configs.html" title="Next Chapter: Derive configs"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Derive configs &raquo;</span>
120
- </a>
121
- </li>
122
-
123
-
124
-
125
-
126
-
127
- </ul>
128
-
129
-
130
-
131
- <form class="navbar-form navbar-right" action="../search.html" method="get">
132
- <div class="form-group">
133
- <input type="text" name="q" class="form-control" placeholder="Search" />
134
- </div>
135
- <input type="hidden" name="check_keywords" value="yes" />
136
- <input type="hidden" name="area" value="default" />
137
- </form>
138
-
139
- </div>
140
- </div>
141
- </div>
142
-
143
- <div class="container">
144
- <div class="row">
145
- <div class="col-md-12">
146
-
147
- <div class="section" id="variables-in-project-meta">
148
- <h1>Variables in Project.meta<a class="headerlink" href="#variables-in-project-meta" title="Permalink to this headline">¶</a></h1>
149
- <p>bake allows you to use pre defined and/or user defined variables in your Project.meta file.
150
- Defined variables then can be used using the following syntax:</p>
151
- <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>MyIncludes<span class="o">)</span>
152
- </pre></div>
153
- </div>
154
- <p>The variable MyIncludes will be substitued by its value, therefore a real life usage would look
155
- something like this:</p>
156
- <div class="highlight-console"><div class="highlight"><pre><span class="go">IncludeDir &quot;$(MyIncludes)&quot;</span>
157
- </pre></div>
158
- </div>
159
- <div class="section" id="user-defined-variables">
160
- <h2>User defined variables<a class="headerlink" href="#user-defined-variables" title="Permalink to this headline">¶</a></h2>
161
- <p>There are two ways to create user defined variables.</p>
162
- <ol class="arabic simple">
163
- <li>The variable is defined with the <cite>&#8211;set</cite> command line option:</li>
164
- </ol>
165
- <div class="highlight-console"><div class="highlight"><pre><span class="gp">User@Host:~$</span> bake ... --set <span class="nv">MyVar</span><span class="o">=</span><span class="s2">&quot;Hello world!&quot;</span>
166
- </pre></div>
167
- </div>
168
- <ol class="arabic simple">
169
- <li>THe variable is defined directly in the Project.meta file.</li>
170
- </ol>
171
- <div class="highlight-console"><div class="highlight"><pre><span class="go">Set MyVar, value: &quot;Hello world!&quot;</span>
172
- </pre></div>
173
- </div>
174
- </div>
175
- <div class="section" id="pre-defined-bake-environment-variables">
176
- <h2>Pre defined bake environment variables<a class="headerlink" href="#pre-defined-bake-environment-variables" title="Permalink to this headline">¶</a></h2>
177
- <table border="1" class="docutils">
178
- <colgroup>
179
- <col width="31%" />
180
- <col width="37%" />
181
- <col width="31%" />
182
- </colgroup>
183
- <thead valign="bottom">
184
- <tr class="row-odd"><th class="head">Variable</th>
185
- <th class="head">Description</th>
186
- <th class="head">Example</th>
187
- </tr>
188
- </thead>
189
- <tbody valign="top">
190
- <tr class="row-even"><td><em>$(MainConfigName)</em></td>
191
- <td>Evaluates to the main config name</td>
192
- <td>Debug</td>
193
- </tr>
194
- <tr class="row-odd"><td><em>$(MainProjectName)</em></td>
195
- <td>Evaluates to the main project name</td>
196
- <td>bootloader</td>
197
- </tr>
198
- <tr class="row-even"><td><em>$(ConfigName)</em></td>
199
- <td>Evaluates to the config name</td>
200
- <td>lib</td>
201
- </tr>
202
- <tr class="row-odd"><td><em>$(ProjectName)</em></td>
203
- <td>Evaluates to the project name</td>
204
- <td>canDriver</td>
205
- </tr>
206
- <tr class="row-even"><td><em>$(ProjectDir)</em></td>
207
- <td>Evaluates to the full path of the project
208
- directory</td>
209
- <td>C:/Root/MyProject</td>
210
- </tr>
211
- <tr class="row-odd"><td><em>$(MainProjectDir)</em></td>
212
- <td>Evaluates to the full path of the root projec
213
- directory</td>
214
- <td>C:/Root/Main</td>
215
- </tr>
216
- <tr class="row-even"><td><em>$(OutputDir)</em></td>
217
- <td>Evaluates to the full path of the output
218
- directory of the current config</td>
219
- <td>build/lib_bootloader_Debug</td>
220
- </tr>
221
- <tr class="row-odd"><td><em>$(OutputDir,projName,confName)</em></td>
222
- <td>Evaluates to the output dir of a specific
223
- config</td>
224
- <td>build/lib_some_Debug</td>
225
- </tr>
226
- <tr class="row-even"><td><em>$(ArtifactName)</em></td>
227
- <td>Evaluates to the artifact.</td>
228
- <td>bootloader_1.0.elf</td>
229
- </tr>
230
- <tr class="row-odd"><td><em>$(ArtifactNameBase)</em></td>
231
- <td>Evaluates to the base artifact name
232
- (Without file exension)</td>
233
- <td>bootloader_1.0</td>
234
- </tr>
235
- <tr class="row-even"><td><em>$(Time)</em></td>
236
- <td>Evaluates to the current time</td>
237
- <td>2012-12-24 20:00:00 +0200</td>
238
- </tr>
239
- <tr class="row-odd"><td><em>$(Hostname)</em></td>
240
- <td>Evaluates to the hostname</td>
241
- <td>MY_COMPUTER</td>
242
- </tr>
243
- <tr class="row-even"><td><em>$(CPPPath)</em></td>
244
- <td>Evaluates to the base path of the
245
- c++ compiler</td>
246
- <td>/usr/bin</td>
247
- </tr>
248
- <tr class="row-odd"><td><em>$(CPath)</em></td>
249
- <td>Evaluates to the base path of the
250
- c compiler</td>
251
- <td>/usr/bin</td>
252
- </tr>
253
- <tr class="row-even"><td><em>$(ASMPath)</em></td>
254
- <td>Evaluates to the base path of the
255
- assembler</td>
256
- <td>/usr/bin</td>
257
- </tr>
258
- <tr class="row-odd"><td><em>$(ArchiverPath)</em></td>
259
- <td>Evaluates to the base path of the
260
- archiver</td>
261
- <td>/usr/bin</td>
262
- </tr>
263
- <tr class="row-even"><td><em>$(LinkerPath)</em></td>
264
- <td>Evaluates to the base path of the
265
- linker</td>
266
- <td>/usr/bin</td>
267
- </tr>
268
- <tr class="row-odd"><td><em>$(/)</em></td>
269
- <td>Evalutes to the directory path seperator of
270
- the current platform</td>
271
- <td>Windows: \, Other: /</td>
272
- </tr>
273
- <tr class="row-even"><td><em>$(:)</em></td>
274
- <td>Evaluates to the path variable seperator
275
- of the current platform</td>
276
- <td>Windows: ;, Other: :</td>
277
- </tr>
278
- </tbody>
279
- </table>
280
- <div class="admonition tip">
281
- <p class="first admonition-title">Tip</p>
282
- <p>It is also possible to retrieve arbitrary an <em>environment variable</em> using the following syntax:</p>
283
- <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>EnvironmentVariable<span class="o">)</span>
284
- </pre></div>
285
- </div>
286
- <p class="last">Evaluates to the Environment with the specified name, if the specified environment variable does not exists
287
- it will be substituted by an empty string.</p>
288
- </div>
289
- <div class="admonition note">
290
- <p class="first admonition-title">Note</p>
291
- <p>Equal variables in the main config</p>
292
- <table border="1" class="last docutils">
293
- <colgroup>
294
- <col width="50%" />
295
- <col width="50%" />
296
- </colgroup>
297
- <thead valign="bottom">
298
- <tr class="row-odd"><th class="head">Variable</th>
299
- <th class="head">Is equal to</th>
300
- </tr>
301
- </thead>
302
- <tbody valign="top">
303
- <tr class="row-even"><td>$(MainConfigName)</td>
304
- <td>$(ConfigName)</td>
305
- </tr>
306
- <tr class="row-odd"><td>$(MainProjectName)</td>
307
- <td>$(ProjectName)</td>
308
- </tr>
309
- </tbody>
310
- </table>
311
- </div>
312
- <div class="admonition warning">
313
- <p class="first admonition-title">Warning</p>
314
- <p class="last">Variables in Dependency definitions are not allowed!</p>
315
- </div>
316
- </div>
317
- <div class="section" id="nested-variables">
318
- <h2>Nested variables<a class="headerlink" href="#nested-variables" title="Permalink to this headline">¶</a></h2>
319
- <p>It is also possible to nest variables.</p>
320
- <p>Example:</p>
321
- <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>OutputDir,<span class="k">$(</span>TheProject<span class="k">)</span>,<span class="k">$(</span>TheConfig<span class="k">)</span><span class="o">)</span>
322
- <span class="gp">$</span><span class="o">(</span>ABC<span class="k">$(</span>DEF<span class="k">)</span>GH<span class="o">)</span>
323
- </pre></div>
324
- </div>
325
- </div>
326
- <div class="section" id="auto-adjustment-of-paths-to-existing-projects">
327
- <h2>Auto-adjustment of paths to existing projects<a class="headerlink" href="#auto-adjustment-of-paths-to-existing-projects" title="Permalink to this headline">¶</a></h2>
328
- <div class="admonition warning">
329
- <p class="first admonition-title">Warning</p>
330
- <p>If paths to other projects are needed, e.g. to &#8220;bootloaderUpdater&#8221;, don&#8217;t write a hard coded relative path like this:</p>
331
- <div class="last highlight-text"><div class="highlight"><pre>CommandLine &quot;../bootloaderUpdater/tools/PrimaryBootloader2Include.exe
332
- </pre></div>
333
- </div>
334
- </div>
335
- <p>If paths to other projects are needed, e.g. to &#8220;bootloaderUpdater&#8221; just reference it starting from the project folder.</p>
336
- <p>Example:</p>
337
- <div class="highlight-text"><div class="highlight"><pre>CommandLine &quot;bootloaderUpdater/tools/PrimaryBootloader2Include.exe
338
- </pre></div>
339
- </div>
340
- <p>or:</p>
341
- <div class="highlight-text"><div class="highlight"><pre>IncludeDir &quot;myProjectName/bootloaderUpdater/whatever&quot;
342
- </pre></div>
343
- </div>
344
- <p>bake recognizes that the first part of the path is a valid project name and calculates the relative path to the project automatically.
345
- If you have the special case that the referenced project is contained in an other workspace root, you can use the
346
- <cite>-w</cite> parameter or you define a <cite>roots.bake</cite>.</p>
347
- <div class="admonition note">
348
- <p class="first admonition-title">Note</p>
349
- <p>The path auto adjustment is applied for the following elements:</p>
350
- <ul class="last simple">
351
- <li>IncludeDir</li>
352
- <li>ExternalLibrary</li>
353
- <li>ExternalLibrarySearchPath</li>
354
- <li>UserLibrary</li>
355
- <li>CommandLine</li>
356
- </ul>
357
- </div>
358
- </div>
359
- </div>
360
-
361
-
362
- </div>
363
-
364
- </div>
365
- </div>
366
- <footer class="footer">
367
- <div class="container">
368
- <p class="pull-right">
369
- <a href="#">Back to top</a>
370
-
371
- </p>
372
- <p>
373
- &copy; Copyright 2016, E.S.R.Labs AG.<br/>
374
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
375
- </p>
376
- </div>
377
- </footer>
378
- </body>
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>Variables in Project.meta &mdash; bake 2.19.1 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: '2.19.1',
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 2.19.1 documentation" href="../index.html" />
33
+ <link rel="up" title="Syntax" href="syntax.html" />
34
+ <link rel="next" title="Derive configs" href="derive_configs.html" />
35
+ <link rel="prev" title="The Syntax of the Project.meta file" href="project_meta_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_conformant_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">Tips and Tricks</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="#">Variables in Project.meta</a><ul>
100
+ <li><a class="reference internal" href="#user-defined-variables">User defined variables</a></li>
101
+ <li><a class="reference internal" href="#pre-defined-bake-environment-variables">Pre defined bake environment variables</a></li>
102
+ <li><a class="reference internal" href="#nested-variables">Nested variables</a></li>
103
+ <li><a class="reference internal" href="#auto-adjustment-of-paths-to-existing-projects">Auto-adjustment of paths to existing projects</a></li>
104
+ </ul>
105
+ </li>
106
+ </ul>
107
+ </ul>
108
+ </li>
109
+
110
+
111
+
112
+
113
+
114
+ <li>
115
+ <a href="project_meta_syntax.html" title="Previous Chapter: The Syntax of the Project.meta file"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; The Syntax of...</span>
116
+ </a>
117
+ </li>
118
+ <li>
119
+ <a href="derive_configs.html" title="Next Chapter: Derive configs"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Derive configs &raquo;</span>
120
+ </a>
121
+ </li>
122
+
123
+
124
+
125
+
126
+
127
+ </ul>
128
+
129
+
130
+
131
+ <form class="navbar-form navbar-right" action="../search.html" method="get">
132
+ <div class="form-group">
133
+ <input type="text" name="q" class="form-control" placeholder="Search" />
134
+ </div>
135
+ <input type="hidden" name="check_keywords" value="yes" />
136
+ <input type="hidden" name="area" value="default" />
137
+ </form>
138
+
139
+ </div>
140
+ </div>
141
+ </div>
142
+
143
+ <div class="container">
144
+ <div class="row">
145
+ <div class="col-md-12">
146
+
147
+ <div class="section" id="variables-in-project-meta">
148
+ <h1>Variables in Project.meta<a class="headerlink" href="#variables-in-project-meta" title="Permalink to this headline">¶</a></h1>
149
+ <p>bake allows you to use pre defined and/or user defined variables in your Project.meta file.
150
+ Defined variables then can be used using the following syntax:</p>
151
+ <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>MyIncludes<span class="o">)</span>
152
+ </pre></div>
153
+ </div>
154
+ <p>The variable MyIncludes will be substitued by its value, therefore a real life usage would look
155
+ something like this:</p>
156
+ <div class="highlight-console"><div class="highlight"><pre><span class="go">IncludeDir &quot;$(MyIncludes)&quot;</span>
157
+ </pre></div>
158
+ </div>
159
+ <div class="section" id="user-defined-variables">
160
+ <h2>User defined variables<a class="headerlink" href="#user-defined-variables" title="Permalink to this headline">¶</a></h2>
161
+ <p>There are two ways to create user defined variables.</p>
162
+ <ol class="arabic simple">
163
+ <li>The variable is defined with the <cite>&#8211;set</cite> command line option:</li>
164
+ </ol>
165
+ <div class="highlight-console"><div class="highlight"><pre><span class="gp">User@Host:~$</span> bake ... --set <span class="nv">MyVar</span><span class="o">=</span><span class="s2">&quot;Hello world!&quot;</span>
166
+ </pre></div>
167
+ </div>
168
+ <ol class="arabic simple">
169
+ <li>THe variable is defined directly in the Project.meta file.</li>
170
+ </ol>
171
+ <div class="highlight-console"><div class="highlight"><pre><span class="go">Set MyVar, value: &quot;Hello world!&quot;</span>
172
+ </pre></div>
173
+ </div>
174
+ </div>
175
+ <div class="section" id="pre-defined-bake-environment-variables">
176
+ <h2>Pre defined bake environment variables<a class="headerlink" href="#pre-defined-bake-environment-variables" title="Permalink to this headline">¶</a></h2>
177
+ <table border="1" class="docutils">
178
+ <colgroup>
179
+ <col width="31%" />
180
+ <col width="37%" />
181
+ <col width="31%" />
182
+ </colgroup>
183
+ <thead valign="bottom">
184
+ <tr class="row-odd"><th class="head">Variable</th>
185
+ <th class="head">Description</th>
186
+ <th class="head">Example</th>
187
+ </tr>
188
+ </thead>
189
+ <tbody valign="top">
190
+ <tr class="row-even"><td><em>$(MainConfigName)</em></td>
191
+ <td>Evaluates to the main config name</td>
192
+ <td>Debug</td>
193
+ </tr>
194
+ <tr class="row-odd"><td><em>$(MainProjectName)</em></td>
195
+ <td>Evaluates to the main project name</td>
196
+ <td>bootloader</td>
197
+ </tr>
198
+ <tr class="row-even"><td><em>$(ConfigName)</em></td>
199
+ <td>Evaluates to the config name</td>
200
+ <td>lib</td>
201
+ </tr>
202
+ <tr class="row-odd"><td><em>$(ProjectName)</em></td>
203
+ <td>Evaluates to the project name</td>
204
+ <td>canDriver</td>
205
+ </tr>
206
+ <tr class="row-even"><td><em>$(ProjectDir)</em></td>
207
+ <td>Evaluates to the full path of the project
208
+ directory</td>
209
+ <td>C:/Root/MyProject</td>
210
+ </tr>
211
+ <tr class="row-odd"><td><em>$(MainProjectDir)</em></td>
212
+ <td>Evaluates to the full path of the root projec
213
+ directory</td>
214
+ <td>C:/Root/Main</td>
215
+ </tr>
216
+ <tr class="row-even"><td><em>$(OutputDir)</em></td>
217
+ <td>Evaluates to the full path of the output
218
+ directory of the current config</td>
219
+ <td>build/lib_bootloader_Debug</td>
220
+ </tr>
221
+ <tr class="row-odd"><td><em>$(OutputDir,projName,confName)</em></td>
222
+ <td>Evaluates to the output dir of a specific
223
+ config</td>
224
+ <td>build/lib_some_Debug</td>
225
+ </tr>
226
+ <tr class="row-even"><td><em>$(ArtifactName)</em></td>
227
+ <td>Evaluates to the artifact.</td>
228
+ <td>bootloader_1.0.elf</td>
229
+ </tr>
230
+ <tr class="row-odd"><td><em>$(ArtifactNameBase)</em></td>
231
+ <td>Evaluates to the base artifact name
232
+ (Without file exension)</td>
233
+ <td>bootloader_1.0</td>
234
+ </tr>
235
+ <tr class="row-even"><td><em>$(Time)</em></td>
236
+ <td>Evaluates to the current time</td>
237
+ <td>2012-12-24 20:00:00 +0200</td>
238
+ </tr>
239
+ <tr class="row-odd"><td><em>$(Hostname)</em></td>
240
+ <td>Evaluates to the hostname</td>
241
+ <td>MY_COMPUTER</td>
242
+ </tr>
243
+ <tr class="row-even"><td><em>$(CPPPath)</em></td>
244
+ <td>Evaluates to the base path of the
245
+ c++ compiler</td>
246
+ <td>/usr/bin</td>
247
+ </tr>
248
+ <tr class="row-odd"><td><em>$(CPath)</em></td>
249
+ <td>Evaluates to the base path of the
250
+ c compiler</td>
251
+ <td>/usr/bin</td>
252
+ </tr>
253
+ <tr class="row-even"><td><em>$(ASMPath)</em></td>
254
+ <td>Evaluates to the base path of the
255
+ assembler</td>
256
+ <td>/usr/bin</td>
257
+ </tr>
258
+ <tr class="row-odd"><td><em>$(ArchiverPath)</em></td>
259
+ <td>Evaluates to the base path of the
260
+ archiver</td>
261
+ <td>/usr/bin</td>
262
+ </tr>
263
+ <tr class="row-even"><td><em>$(LinkerPath)</em></td>
264
+ <td>Evaluates to the base path of the
265
+ linker</td>
266
+ <td>/usr/bin</td>
267
+ </tr>
268
+ <tr class="row-odd"><td><em>$(/)</em></td>
269
+ <td>Evalutes to the directory path seperator of
270
+ the current platform</td>
271
+ <td>Windows: \, Other: /</td>
272
+ </tr>
273
+ <tr class="row-even"><td><em>$(:)</em></td>
274
+ <td>Evaluates to the path variable seperator
275
+ of the current platform</td>
276
+ <td>Windows: ;, Other: :</td>
277
+ </tr>
278
+ </tbody>
279
+ </table>
280
+ <div class="admonition tip">
281
+ <p class="first admonition-title">Tip</p>
282
+ <p>It is also possible to retrieve arbitrary an <em>environment variable</em> using the following syntax:</p>
283
+ <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>EnvironmentVariable<span class="o">)</span>
284
+ </pre></div>
285
+ </div>
286
+ <p class="last">Evaluates to the Environment with the specified name, if the specified environment variable does not exists
287
+ it will be substituted by an empty string.</p>
288
+ </div>
289
+ <div class="admonition note">
290
+ <p class="first admonition-title">Note</p>
291
+ <p>Equal variables in the main config</p>
292
+ <table border="1" class="last docutils">
293
+ <colgroup>
294
+ <col width="50%" />
295
+ <col width="50%" />
296
+ </colgroup>
297
+ <thead valign="bottom">
298
+ <tr class="row-odd"><th class="head">Variable</th>
299
+ <th class="head">Is equal to</th>
300
+ </tr>
301
+ </thead>
302
+ <tbody valign="top">
303
+ <tr class="row-even"><td>$(MainConfigName)</td>
304
+ <td>$(ConfigName)</td>
305
+ </tr>
306
+ <tr class="row-odd"><td>$(MainProjectName)</td>
307
+ <td>$(ProjectName)</td>
308
+ </tr>
309
+ </tbody>
310
+ </table>
311
+ </div>
312
+ <div class="admonition warning">
313
+ <p class="first admonition-title">Warning</p>
314
+ <p class="last">Variables in Dependency definitions are not allowed!</p>
315
+ </div>
316
+ </div>
317
+ <div class="section" id="nested-variables">
318
+ <h2>Nested variables<a class="headerlink" href="#nested-variables" title="Permalink to this headline">¶</a></h2>
319
+ <p>It is also possible to nest variables.</p>
320
+ <p>Example:</p>
321
+ <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>OutputDir,<span class="k">$(</span>TheProject<span class="k">)</span>,<span class="k">$(</span>TheConfig<span class="k">)</span><span class="o">)</span>
322
+ <span class="gp">$</span><span class="o">(</span>ABC<span class="k">$(</span>DEF<span class="k">)</span>GH<span class="o">)</span>
323
+ </pre></div>
324
+ </div>
325
+ </div>
326
+ <div class="section" id="auto-adjustment-of-paths-to-existing-projects">
327
+ <h2>Auto-adjustment of paths to existing projects<a class="headerlink" href="#auto-adjustment-of-paths-to-existing-projects" title="Permalink to this headline">¶</a></h2>
328
+ <div class="admonition warning">
329
+ <p class="first admonition-title">Warning</p>
330
+ <p>If paths to other projects are needed, e.g. to &#8220;bootloaderUpdater&#8221;, don&#8217;t write a hard coded relative path like this:</p>
331
+ <div class="last highlight-text"><div class="highlight"><pre>CommandLine &quot;../bootloaderUpdater/tools/PrimaryBootloader2Include.exe
332
+ </pre></div>
333
+ </div>
334
+ </div>
335
+ <p>If paths to other projects are needed, e.g. to &#8220;bootloaderUpdater&#8221; just reference it starting from the project folder.</p>
336
+ <p>Example:</p>
337
+ <div class="highlight-text"><div class="highlight"><pre>CommandLine &quot;bootloaderUpdater/tools/PrimaryBootloader2Include.exe
338
+ </pre></div>
339
+ </div>
340
+ <p>or:</p>
341
+ <div class="highlight-text"><div class="highlight"><pre>IncludeDir &quot;myProjectName/bootloaderUpdater/whatever&quot;
342
+ </pre></div>
343
+ </div>
344
+ <p>bake recognizes that the first part of the path is a valid project name and calculates the relative path to the project automatically.
345
+ If you have the special case that the referenced project is contained in an other workspace root, you can use the
346
+ <cite>-w</cite> parameter or you define a <cite>roots.bake</cite>.</p>
347
+ <div class="admonition note">
348
+ <p class="first admonition-title">Note</p>
349
+ <p>The path auto adjustment is applied for the following elements:</p>
350
+ <ul class="last simple">
351
+ <li>IncludeDir</li>
352
+ <li>ExternalLibrary</li>
353
+ <li>ExternalLibrarySearchPath</li>
354
+ <li>UserLibrary</li>
355
+ <li>CommandLine</li>
356
+ </ul>
357
+ </div>
358
+ </div>
359
+ </div>
360
+
361
+
362
+ </div>
363
+
364
+ </div>
365
+ </div>
366
+ <footer class="footer">
367
+ <div class="container">
368
+ <p class="pull-right">
369
+ <a href="#">Back to top</a>
370
+
371
+ </p>
372
+ <p>
373
+ &copy; Copyright 2016, E.S.R.Labs AG.<br/>
374
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
375
+ </p>
376
+ </div>
377
+ </footer>
378
+ </body>
379
379
  </html>