bake-toolkit 2.28.0 → 2.28.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 (57) hide show
  1. checksums.yaml +4 -4
  2. data/documentation/_build/html/_sources/changelog.txt +3 -0
  3. data/documentation/_build/html/_sources/index.txt +1 -1
  4. data/documentation/_build/html/_static/logo_tiny_48.png +0 -0
  5. data/documentation/_build/html/changelog.html +1154 -1149
  6. data/documentation/_build/html/commandline/commandline.html +285 -285
  7. data/documentation/_build/html/concepts/build_hierarchy.html +204 -204
  8. data/documentation/_build/html/concepts/concepts.html +196 -196
  9. data/documentation/_build/html/concepts/inject.html +216 -216
  10. data/documentation/_build/html/concepts/link_order.html +245 -245
  11. data/documentation/_build/html/concepts/prebuild.html +205 -205
  12. data/documentation/_build/html/concepts/the_main_project.html +260 -260
  13. data/documentation/_build/html/concepts/the_project_meta_file.html +288 -288
  14. data/documentation/_build/html/genindex.html +152 -152
  15. data/documentation/_build/html/ide/eclipse/eclipse.html +186 -186
  16. data/documentation/_build/html/ide/eclipse/how_to_convert_existing_cdt_workspace.html +208 -208
  17. data/documentation/_build/html/ide/eclipse/how_to_create_a_new_project_in_eclipse.html +191 -191
  18. data/documentation/_build/html/ide/eclipse/how_to_create_a_workspace_in_eclipse.html +198 -198
  19. data/documentation/_build/html/ide/eclipse/how_to_debug_in_eclipse.html +198 -198
  20. data/documentation/_build/html/ide/eclipse/how_to_install_eclipse_plugin.html +196 -196
  21. data/documentation/_build/html/ide/eclipse/how_to_use_bake_in_eclipse.html +256 -256
  22. data/documentation/_build/html/ide/ide_integrations.html +185 -185
  23. data/documentation/_build/html/ide/vs/how_to_create_vs_projects.html +171 -171
  24. data/documentation/_build/html/ide/vs/how_to_debug_in_vs.html +185 -185
  25. data/documentation/_build/html/ide/vs/how_to_used_bake_in_vs.html +190 -190
  26. data/documentation/_build/html/ide/vs/vs.html +170 -170
  27. data/documentation/_build/html/ide/vs/vs_install.html +202 -202
  28. data/documentation/_build/html/index.html +246 -246
  29. data/documentation/_build/html/install/install_bake.html +279 -279
  30. data/documentation/_build/html/internal.html +217 -217
  31. data/documentation/_build/html/known_issues.html +173 -173
  32. data/documentation/_build/html/license.html +236 -236
  33. data/documentation/_build/html/performance/performance.html +373 -373
  34. data/documentation/_build/html/quickstart/quickstart.html +236 -236
  35. data/documentation/_build/html/search.html +174 -174
  36. data/documentation/_build/html/searchindex.js +1 -1
  37. data/documentation/_build/html/syntax/adapt_configs.html +370 -370
  38. data/documentation/_build/html/syntax/auto_adjustment.html +189 -189
  39. data/documentation/_build/html/syntax/derive_configs.html +247 -247
  40. data/documentation/_build/html/syntax/project_meta_syntax.html +923 -923
  41. data/documentation/_build/html/syntax/syntax.html +196 -196
  42. data/documentation/_build/html/syntax/variable_substitutions.html +365 -365
  43. data/documentation/_build/html/tips_and_tricks/bakeclean.html +169 -169
  44. data/documentation/_build/html/tips_and_tricks/dot.html +186 -186
  45. data/documentation/_build/html/tips_and_tricks/how_to_use_bake_with_cygwin.html +214 -214
  46. data/documentation/_build/html/tips_and_tricks/qac.html +297 -297
  47. data/documentation/_build/html/tips_and_tricks/the_bakery.html +405 -405
  48. data/documentation/_build/html/tips_and_tricks/the_clang.html +201 -201
  49. data/documentation/_build/html/tips_and_tricks/tips_and_tricks.html +198 -198
  50. data/documentation/_build/html/why_bake/why_bake.html +241 -241
  51. data/lib/bake/config/checks.rb +76 -68
  52. data/lib/bake/model/metamodel.rb +6 -0
  53. data/lib/common/version.rb +1 -1
  54. metadata +3 -5
  55. data/documentation/_build/html/_sources/tips_and_tricks/static_code_analysis.txt +0 -122
  56. data/documentation/_build/html/_static/logo_conformant_48.png +0 -0
  57. data/documentation/_build/html/tips_and_tricks/static_code_analysis.html +0 -285
@@ -1,197 +1,197 @@
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 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="next" title="The Syntax of the Project.meta file" href="project_meta_syntax.html" />
34
- <link rel="prev" title="Injection and inheritance of IncludeDir and Dependency" href="../concepts/inject.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">Additional features</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/inject.html" title="Previous Chapter: Injection and inheritance of IncludeDir and Dependency"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Injection and...</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#using-variables">Using variables</a></li>
150
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#user-defined-variables">User defined variables</a></li>
151
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#predefined-bake-environment-variables">Predefined bake environment variables</a></li>
152
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#environment-variables">Environment variables</a></li>
153
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#nested-variables">Nested variables</a></li>
154
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#complex-variables">Complex variables</a></li>
155
- <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#notes-and-warnings">Notes and warnings</a></li>
156
- </ul>
157
- </li>
158
- <li class="toctree-l1"><a class="reference internal" href="derive_configs.html">Derive configs</a><ul>
159
- <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#deriving-a-config">Deriving a config</a></li>
160
- <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#inheritance-implications">Inheritance implications</a></li>
161
- <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#multiple-inheritance">Multiple inheritance</a></li>
162
- </ul>
163
- </li>
164
- <li class="toctree-l1"><a class="reference internal" href="adapt_configs.html">Adapt configs</a><ul>
165
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#introduction">Introduction</a></li>
166
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#from-command-line">From command line</a></li>
167
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#from-project-meta">From Project.meta</a></li>
168
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#conditions-and-effectiveness">Conditions and effectiveness</a></li>
169
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#occurrences">Occurrences</a></li>
170
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#apply-order">Apply order</a></li>
171
- <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#types">Types</a></li>
172
- </ul>
173
- </li>
174
- <li class="toctree-l1"><a class="reference internal" href="auto_adjustment.html">Auto-adjustment of paths to existing projects</a></li>
175
- </ul>
176
- </div>
177
- </div>
178
-
179
-
180
- </div>
181
-
182
- </div>
183
- </div>
184
- <footer class="footer">
185
- <div class="container">
186
- <p class="pull-right">
187
- <a href="#">Back to top</a>
188
-
189
- </p>
190
- <p>
191
- &copy; Copyright 2016, E.S.R.Labs AG.<br/>
192
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
193
- </p>
194
- </div>
195
- </footer>
196
- </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 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="next" title="The Syntax of the Project.meta file" href="project_meta_syntax.html" />
34
+ <link rel="prev" title="Injection and inheritance of IncludeDir and Dependency" href="../concepts/inject.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_tiny_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">Additional features</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/inject.html" title="Previous Chapter: Injection and inheritance of IncludeDir and Dependency"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Injection and...</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#using-variables">Using variables</a></li>
150
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#user-defined-variables">User defined variables</a></li>
151
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#predefined-bake-environment-variables">Predefined bake environment variables</a></li>
152
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#environment-variables">Environment variables</a></li>
153
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#nested-variables">Nested variables</a></li>
154
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#complex-variables">Complex variables</a></li>
155
+ <li class="toctree-l2"><a class="reference internal" href="variable_substitutions.html#notes-and-warnings">Notes and warnings</a></li>
156
+ </ul>
157
+ </li>
158
+ <li class="toctree-l1"><a class="reference internal" href="derive_configs.html">Derive configs</a><ul>
159
+ <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#deriving-a-config">Deriving a config</a></li>
160
+ <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#inheritance-implications">Inheritance implications</a></li>
161
+ <li class="toctree-l2"><a class="reference internal" href="derive_configs.html#multiple-inheritance">Multiple inheritance</a></li>
162
+ </ul>
163
+ </li>
164
+ <li class="toctree-l1"><a class="reference internal" href="adapt_configs.html">Adapt configs</a><ul>
165
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#introduction">Introduction</a></li>
166
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#from-command-line">From command line</a></li>
167
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#from-project-meta">From Project.meta</a></li>
168
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#conditions-and-effectiveness">Conditions and effectiveness</a></li>
169
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#occurrences">Occurrences</a></li>
170
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#apply-order">Apply order</a></li>
171
+ <li class="toctree-l2"><a class="reference internal" href="adapt_configs.html#types">Types</a></li>
172
+ </ul>
173
+ </li>
174
+ <li class="toctree-l1"><a class="reference internal" href="auto_adjustment.html">Auto-adjustment of paths to existing projects</a></li>
175
+ </ul>
176
+ </div>
177
+ </div>
178
+
179
+
180
+ </div>
181
+
182
+ </div>
183
+ </div>
184
+ <footer class="footer">
185
+ <div class="container">
186
+ <p class="pull-right">
187
+ <a href="#">Back to top</a>
188
+
189
+ </p>
190
+ <p>
191
+ &copy; Copyright 2016, E.S.R.Labs AG.<br/>
192
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
193
+ </p>
194
+ </div>
195
+ </footer>
196
+ </body>
197
197
  </html>
@@ -1,366 +1,366 @@
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 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="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">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="#">Variables in Project.meta</a><ul>
100
- <li><a class="reference internal" href="#using-variables">Using variables</a></li>
101
- <li><a class="reference internal" href="#user-defined-variables">User defined variables</a></li>
102
- <li><a class="reference internal" href="#predefined-bake-environment-variables">Predefined bake environment variables</a></li>
103
- <li><a class="reference internal" href="#environment-variables">Environment variables</a></li>
104
- <li><a class="reference internal" href="#nested-variables">Nested variables</a></li>
105
- <li><a class="reference internal" href="#complex-variables">Complex variables</a></li>
106
- <li><a class="reference internal" href="#notes-and-warnings">Notes and warnings</a></li>
107
- </ul>
108
- </li>
109
- </ul>
110
- </ul>
111
- </li>
112
-
113
-
114
-
115
-
116
-
117
- <li>
118
- <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>
119
- </a>
120
- </li>
121
- <li>
122
- <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>
123
- </a>
124
- </li>
125
-
126
-
127
-
128
-
129
-
130
- </ul>
131
-
132
-
133
-
134
- <form class="navbar-form navbar-right" action="../search.html" method="get">
135
- <div class="form-group">
136
- <input type="text" name="q" class="form-control" placeholder="Search" />
137
- </div>
138
- <input type="hidden" name="check_keywords" value="yes" />
139
- <input type="hidden" name="area" value="default" />
140
- </form>
141
-
142
- </div>
143
- </div>
144
- </div>
145
-
146
- <div class="container">
147
- <div class="row">
148
- <div class="col-md-12">
149
-
150
- <div class="section" id="variables-in-project-meta">
151
- <h1>Variables in Project.meta<a class="headerlink" href="#variables-in-project-meta" title="Permalink to this headline">¶</a></h1>
152
- <p>bake allows you to use</p>
153
- <ul class="simple">
154
- <li>user defined</li>
155
- <li>predefined</li>
156
- <li>environment</li>
157
- </ul>
158
- <p>variables in your Project.meta file (in this priority). If a variable is not found, it will be evaluated to an empty string.</p>
159
- <div class="section" id="using-variables">
160
- <h2>Using variables<a class="headerlink" href="#using-variables" title="Permalink to this headline">¶</a></h2>
161
- <p>Variables can be used using the following syntax:</p>
162
- <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>ABC<span class="o">)</span>
163
- </pre></div>
164
- </div>
165
- <p>The variable ABC will be substituted by its value, therefore a real life usage would look
166
- something like this:</p>
167
- <div class="highlight-console"><div class="highlight"><pre><span class="go">IncludeDir &quot;$(ABC)&quot;</span>
168
- </pre></div>
169
- </div>
170
- </div>
171
- <div class="section" id="user-defined-variables">
172
- <h2>User defined variables<a class="headerlink" href="#user-defined-variables" title="Permalink to this headline">¶</a></h2>
173
- <p>There are two ways to create user defined variables.</p>
174
- <ol class="arabic simple">
175
- <li>The variable is defined with the <cite>&#8211;set</cite> command line option:</li>
176
- </ol>
177
- <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>
178
- </pre></div>
179
- </div>
180
- <ol class="arabic simple">
181
- <li>THe variable is defined directly in the Project.meta file.</li>
182
- </ol>
183
- <div class="highlight-console"><div class="highlight"><pre><span class="go">Set MyVar, value: &quot;Hello world!&quot;</span>
184
- <span class="go">Set MyVar, cmd: &quot;ruby calcVar.rb&quot;</span>
185
- </pre></div>
186
- </div>
187
- <p>In the latter one the variable is set to the output of the command.</p>
188
- </div>
189
- <div class="section" id="predefined-bake-environment-variables">
190
- <h2>Predefined bake environment variables<a class="headerlink" href="#predefined-bake-environment-variables" title="Permalink to this headline">¶</a></h2>
191
- <table border="1" class="docutils">
192
- <colgroup>
193
- <col width="31%" />
194
- <col width="37%" />
195
- <col width="31%" />
196
- </colgroup>
197
- <thead valign="bottom">
198
- <tr class="row-odd"><th class="head">Variable</th>
199
- <th class="head">Description</th>
200
- <th class="head">Example</th>
201
- </tr>
202
- </thead>
203
- <tbody valign="top">
204
- <tr class="row-even"><td><em>$(MainConfigName)</em></td>
205
- <td>Evaluates to the main config name</td>
206
- <td>Debug</td>
207
- </tr>
208
- <tr class="row-odd"><td><em>$(MainProjectName)</em></td>
209
- <td>Evaluates to the main project name</td>
210
- <td>bootloader</td>
211
- </tr>
212
- <tr class="row-even"><td><em>$(ConfigName)</em></td>
213
- <td>Evaluates to the config name</td>
214
- <td>lib</td>
215
- </tr>
216
- <tr class="row-odd"><td><em>$(ProjectName)</em></td>
217
- <td>Evaluates to the project name</td>
218
- <td>canDriver</td>
219
- </tr>
220
- <tr class="row-even"><td><em>$(ProjectDir)</em></td>
221
- <td>Evaluates to the full path of the project
222
- directory</td>
223
- <td>C:/Root/MyProject</td>
224
- </tr>
225
- <tr class="row-odd"><td><em>$(MainProjectDir)</em></td>
226
- <td>Evaluates to the full path of the root projec
227
- directory</td>
228
- <td>C:/Root/Main</td>
229
- </tr>
230
- <tr class="row-even"><td><em>$(OutputDir)</em></td>
231
- <td>Evaluates to the full path of the output
232
- directory of the current config</td>
233
- <td>build/lib_bootloader_Debug</td>
234
- </tr>
235
- <tr class="row-odd"><td><em>$(OutputDir,projName,confName)</em></td>
236
- <td>Evaluates to the output dir of a specific
237
- config</td>
238
- <td>build/lib_some_Debug</td>
239
- </tr>
240
- <tr class="row-even"><td><em>$(ArtifactName)</em></td>
241
- <td>Evaluates to the artifact.</td>
242
- <td>bootloader_1.0.elf</td>
243
- </tr>
244
- <tr class="row-odd"><td><em>$(ArtifactNameBase)</em></td>
245
- <td>Evaluates to the base artifact name
246
- (Without file exension)</td>
247
- <td>bootloader_1.0</td>
248
- </tr>
249
- <tr class="row-even"><td><em>$(Time)</em></td>
250
- <td>Evaluates to the current time</td>
251
- <td>2012-12-24 20:00:00 +0200</td>
252
- </tr>
253
- <tr class="row-odd"><td><em>$(Hostname)</em></td>
254
- <td>Evaluates to the hostname</td>
255
- <td>MY_COMPUTER</td>
256
- </tr>
257
- <tr class="row-even"><td><em>$(CPPPath)</em></td>
258
- <td>Evaluates to the base path of the
259
- c++ compiler</td>
260
- <td>/usr/bin</td>
261
- </tr>
262
- <tr class="row-odd"><td><em>$(CPath)</em></td>
263
- <td>Evaluates to the base path of the
264
- c compiler</td>
265
- <td>/usr/bin</td>
266
- </tr>
267
- <tr class="row-even"><td><em>$(ASMPath)</em></td>
268
- <td>Evaluates to the base path of the
269
- assembler</td>
270
- <td>/usr/bin</td>
271
- </tr>
272
- <tr class="row-odd"><td><em>$(ArchiverPath)</em></td>
273
- <td>Evaluates to the base path of the
274
- archiver</td>
275
- <td>/usr/bin</td>
276
- </tr>
277
- <tr class="row-even"><td><em>$(LinkerPath)</em></td>
278
- <td>Evaluates to the base path of the
279
- linker</td>
280
- <td>/usr/bin</td>
281
- </tr>
282
- <tr class="row-odd"><td><em>$(ToolchainName)</em></td>
283
- <td>Names of the used DefaultToolchain</td>
284
- <td>GCC</td>
285
- </tr>
286
- <tr class="row-even"><td><em>$(/)</em></td>
287
- <td>Evalutes to the directory path seperator of
288
- the current platform</td>
289
- <td>Windows: \, Other: /</td>
290
- </tr>
291
- <tr class="row-odd"><td><em>$(:)</em></td>
292
- <td>Evaluates to the path variable seperator
293
- of the current platform</td>
294
- <td>Windows: ;, Other: :</td>
295
- </tr>
296
- </tbody>
297
- </table>
298
- </div>
299
- <div class="section" id="environment-variables">
300
- <h2>Environment variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2>
301
- <p>Usually used if system dependent stuff is needed like path to a specific tool etc.</p>
302
- </div>
303
- <div class="section" id="nested-variables">
304
- <h2>Nested variables<a class="headerlink" href="#nested-variables" title="Permalink to this headline">¶</a></h2>
305
- <p>It is also possible to nest variables.</p>
306
- <p>Example:</p>
307
- <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>ABC<span class="k">$(</span>DEF<span class="k">)</span>GH<span class="o">)</span>
308
- </pre></div>
309
- </div>
310
- </div>
311
- <div class="section" id="complex-variables">
312
- <h2>Complex variables<a class="headerlink" href="#complex-variables" title="Permalink to this headline">¶</a></h2>
313
- <p>bake supports one complex variable:</p>
314
- <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>
315
- </pre></div>
316
- </div>
317
- <p>This will evaluate to the output directory of a specific configuration.</p>
318
- </div>
319
- <div class="section" id="notes-and-warnings">
320
- <h2>Notes and warnings<a class="headerlink" href="#notes-and-warnings" title="Permalink to this headline">¶</a></h2>
321
- <p>Equal variables in the main config:</p>
322
- <table border="1" class="docutils">
323
- <colgroup>
324
- <col width="50%" />
325
- <col width="50%" />
326
- </colgroup>
327
- <thead valign="bottom">
328
- <tr class="row-odd"><th class="head">Variable</th>
329
- <th class="head">Is equal to</th>
330
- </tr>
331
- </thead>
332
- <tbody valign="top">
333
- <tr class="row-even"><td>$(MainConfigName)</td>
334
- <td>$(ConfigName)</td>
335
- </tr>
336
- <tr class="row-odd"><td>$(MainProjectName)</td>
337
- <td>$(ProjectName)</td>
338
- </tr>
339
- </tbody>
340
- </table>
341
- <div class="admonition warning">
342
- <p class="first admonition-title">Warning</p>
343
- <p class="last">Variables in Dependency definitions are not allowed!</p>
344
- </div>
345
- </div>
346
- </div>
347
-
348
-
349
- </div>
350
-
351
- </div>
352
- </div>
353
- <footer class="footer">
354
- <div class="container">
355
- <p class="pull-right">
356
- <a href="#">Back to top</a>
357
-
358
- </p>
359
- <p>
360
- &copy; Copyright 2016, E.S.R.Labs AG.<br/>
361
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
362
- </p>
363
- </div>
364
- </footer>
365
- </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 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="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_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="#">Variables in Project.meta</a><ul>
100
+ <li><a class="reference internal" href="#using-variables">Using variables</a></li>
101
+ <li><a class="reference internal" href="#user-defined-variables">User defined variables</a></li>
102
+ <li><a class="reference internal" href="#predefined-bake-environment-variables">Predefined bake environment variables</a></li>
103
+ <li><a class="reference internal" href="#environment-variables">Environment variables</a></li>
104
+ <li><a class="reference internal" href="#nested-variables">Nested variables</a></li>
105
+ <li><a class="reference internal" href="#complex-variables">Complex variables</a></li>
106
+ <li><a class="reference internal" href="#notes-and-warnings">Notes and warnings</a></li>
107
+ </ul>
108
+ </li>
109
+ </ul>
110
+ </ul>
111
+ </li>
112
+
113
+
114
+
115
+
116
+
117
+ <li>
118
+ <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>
119
+ </a>
120
+ </li>
121
+ <li>
122
+ <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>
123
+ </a>
124
+ </li>
125
+
126
+
127
+
128
+
129
+
130
+ </ul>
131
+
132
+
133
+
134
+ <form class="navbar-form navbar-right" action="../search.html" method="get">
135
+ <div class="form-group">
136
+ <input type="text" name="q" class="form-control" placeholder="Search" />
137
+ </div>
138
+ <input type="hidden" name="check_keywords" value="yes" />
139
+ <input type="hidden" name="area" value="default" />
140
+ </form>
141
+
142
+ </div>
143
+ </div>
144
+ </div>
145
+
146
+ <div class="container">
147
+ <div class="row">
148
+ <div class="col-md-12">
149
+
150
+ <div class="section" id="variables-in-project-meta">
151
+ <h1>Variables in Project.meta<a class="headerlink" href="#variables-in-project-meta" title="Permalink to this headline">¶</a></h1>
152
+ <p>bake allows you to use</p>
153
+ <ul class="simple">
154
+ <li>user defined</li>
155
+ <li>predefined</li>
156
+ <li>environment</li>
157
+ </ul>
158
+ <p>variables in your Project.meta file (in this priority). If a variable is not found, it will be evaluated to an empty string.</p>
159
+ <div class="section" id="using-variables">
160
+ <h2>Using variables<a class="headerlink" href="#using-variables" title="Permalink to this headline">¶</a></h2>
161
+ <p>Variables can be used using the following syntax:</p>
162
+ <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>ABC<span class="o">)</span>
163
+ </pre></div>
164
+ </div>
165
+ <p>The variable ABC will be substituted by its value, therefore a real life usage would look
166
+ something like this:</p>
167
+ <div class="highlight-console"><div class="highlight"><pre><span class="go">IncludeDir &quot;$(ABC)&quot;</span>
168
+ </pre></div>
169
+ </div>
170
+ </div>
171
+ <div class="section" id="user-defined-variables">
172
+ <h2>User defined variables<a class="headerlink" href="#user-defined-variables" title="Permalink to this headline">¶</a></h2>
173
+ <p>There are two ways to create user defined variables.</p>
174
+ <ol class="arabic simple">
175
+ <li>The variable is defined with the <cite>&#8211;set</cite> command line option:</li>
176
+ </ol>
177
+ <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>
178
+ </pre></div>
179
+ </div>
180
+ <ol class="arabic simple">
181
+ <li>THe variable is defined directly in the Project.meta file.</li>
182
+ </ol>
183
+ <div class="highlight-console"><div class="highlight"><pre><span class="go">Set MyVar, value: &quot;Hello world!&quot;</span>
184
+ <span class="go">Set MyVar, cmd: &quot;ruby calcVar.rb&quot;</span>
185
+ </pre></div>
186
+ </div>
187
+ <p>In the latter one the variable is set to the output of the command.</p>
188
+ </div>
189
+ <div class="section" id="predefined-bake-environment-variables">
190
+ <h2>Predefined bake environment variables<a class="headerlink" href="#predefined-bake-environment-variables" title="Permalink to this headline">¶</a></h2>
191
+ <table border="1" class="docutils">
192
+ <colgroup>
193
+ <col width="31%" />
194
+ <col width="37%" />
195
+ <col width="31%" />
196
+ </colgroup>
197
+ <thead valign="bottom">
198
+ <tr class="row-odd"><th class="head">Variable</th>
199
+ <th class="head">Description</th>
200
+ <th class="head">Example</th>
201
+ </tr>
202
+ </thead>
203
+ <tbody valign="top">
204
+ <tr class="row-even"><td><em>$(MainConfigName)</em></td>
205
+ <td>Evaluates to the main config name</td>
206
+ <td>Debug</td>
207
+ </tr>
208
+ <tr class="row-odd"><td><em>$(MainProjectName)</em></td>
209
+ <td>Evaluates to the main project name</td>
210
+ <td>bootloader</td>
211
+ </tr>
212
+ <tr class="row-even"><td><em>$(ConfigName)</em></td>
213
+ <td>Evaluates to the config name</td>
214
+ <td>lib</td>
215
+ </tr>
216
+ <tr class="row-odd"><td><em>$(ProjectName)</em></td>
217
+ <td>Evaluates to the project name</td>
218
+ <td>canDriver</td>
219
+ </tr>
220
+ <tr class="row-even"><td><em>$(ProjectDir)</em></td>
221
+ <td>Evaluates to the full path of the project
222
+ directory</td>
223
+ <td>C:/Root/MyProject</td>
224
+ </tr>
225
+ <tr class="row-odd"><td><em>$(MainProjectDir)</em></td>
226
+ <td>Evaluates to the full path of the root projec
227
+ directory</td>
228
+ <td>C:/Root/Main</td>
229
+ </tr>
230
+ <tr class="row-even"><td><em>$(OutputDir)</em></td>
231
+ <td>Evaluates to the full path of the output
232
+ directory of the current config</td>
233
+ <td>build/lib_bootloader_Debug</td>
234
+ </tr>
235
+ <tr class="row-odd"><td><em>$(OutputDir,projName,confName)</em></td>
236
+ <td>Evaluates to the output dir of a specific
237
+ config</td>
238
+ <td>build/lib_some_Debug</td>
239
+ </tr>
240
+ <tr class="row-even"><td><em>$(ArtifactName)</em></td>
241
+ <td>Evaluates to the artifact.</td>
242
+ <td>bootloader_1.0.elf</td>
243
+ </tr>
244
+ <tr class="row-odd"><td><em>$(ArtifactNameBase)</em></td>
245
+ <td>Evaluates to the base artifact name
246
+ (Without file exension)</td>
247
+ <td>bootloader_1.0</td>
248
+ </tr>
249
+ <tr class="row-even"><td><em>$(Time)</em></td>
250
+ <td>Evaluates to the current time</td>
251
+ <td>2012-12-24 20:00:00 +0200</td>
252
+ </tr>
253
+ <tr class="row-odd"><td><em>$(Hostname)</em></td>
254
+ <td>Evaluates to the hostname</td>
255
+ <td>MY_COMPUTER</td>
256
+ </tr>
257
+ <tr class="row-even"><td><em>$(CPPPath)</em></td>
258
+ <td>Evaluates to the base path of the
259
+ c++ compiler</td>
260
+ <td>/usr/bin</td>
261
+ </tr>
262
+ <tr class="row-odd"><td><em>$(CPath)</em></td>
263
+ <td>Evaluates to the base path of the
264
+ c compiler</td>
265
+ <td>/usr/bin</td>
266
+ </tr>
267
+ <tr class="row-even"><td><em>$(ASMPath)</em></td>
268
+ <td>Evaluates to the base path of the
269
+ assembler</td>
270
+ <td>/usr/bin</td>
271
+ </tr>
272
+ <tr class="row-odd"><td><em>$(ArchiverPath)</em></td>
273
+ <td>Evaluates to the base path of the
274
+ archiver</td>
275
+ <td>/usr/bin</td>
276
+ </tr>
277
+ <tr class="row-even"><td><em>$(LinkerPath)</em></td>
278
+ <td>Evaluates to the base path of the
279
+ linker</td>
280
+ <td>/usr/bin</td>
281
+ </tr>
282
+ <tr class="row-odd"><td><em>$(ToolchainName)</em></td>
283
+ <td>Names of the used DefaultToolchain</td>
284
+ <td>GCC</td>
285
+ </tr>
286
+ <tr class="row-even"><td><em>$(/)</em></td>
287
+ <td>Evalutes to the directory path seperator of
288
+ the current platform</td>
289
+ <td>Windows: \, Other: /</td>
290
+ </tr>
291
+ <tr class="row-odd"><td><em>$(:)</em></td>
292
+ <td>Evaluates to the path variable seperator
293
+ of the current platform</td>
294
+ <td>Windows: ;, Other: :</td>
295
+ </tr>
296
+ </tbody>
297
+ </table>
298
+ </div>
299
+ <div class="section" id="environment-variables">
300
+ <h2>Environment variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2>
301
+ <p>Usually used if system dependent stuff is needed like path to a specific tool etc.</p>
302
+ </div>
303
+ <div class="section" id="nested-variables">
304
+ <h2>Nested variables<a class="headerlink" href="#nested-variables" title="Permalink to this headline">¶</a></h2>
305
+ <p>It is also possible to nest variables.</p>
306
+ <p>Example:</p>
307
+ <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span><span class="o">(</span>ABC<span class="k">$(</span>DEF<span class="k">)</span>GH<span class="o">)</span>
308
+ </pre></div>
309
+ </div>
310
+ </div>
311
+ <div class="section" id="complex-variables">
312
+ <h2>Complex variables<a class="headerlink" href="#complex-variables" title="Permalink to this headline">¶</a></h2>
313
+ <p>bake supports one complex variable:</p>
314
+ <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>
315
+ </pre></div>
316
+ </div>
317
+ <p>This will evaluate to the output directory of a specific configuration.</p>
318
+ </div>
319
+ <div class="section" id="notes-and-warnings">
320
+ <h2>Notes and warnings<a class="headerlink" href="#notes-and-warnings" title="Permalink to this headline">¶</a></h2>
321
+ <p>Equal variables in the main config:</p>
322
+ <table border="1" class="docutils">
323
+ <colgroup>
324
+ <col width="50%" />
325
+ <col width="50%" />
326
+ </colgroup>
327
+ <thead valign="bottom">
328
+ <tr class="row-odd"><th class="head">Variable</th>
329
+ <th class="head">Is equal to</th>
330
+ </tr>
331
+ </thead>
332
+ <tbody valign="top">
333
+ <tr class="row-even"><td>$(MainConfigName)</td>
334
+ <td>$(ConfigName)</td>
335
+ </tr>
336
+ <tr class="row-odd"><td>$(MainProjectName)</td>
337
+ <td>$(ProjectName)</td>
338
+ </tr>
339
+ </tbody>
340
+ </table>
341
+ <div class="admonition warning">
342
+ <p class="first admonition-title">Warning</p>
343
+ <p class="last">Variables in Dependency definitions are not allowed!</p>
344
+ </div>
345
+ </div>
346
+ </div>
347
+
348
+
349
+ </div>
350
+
351
+ </div>
352
+ </div>
353
+ <footer class="footer">
354
+ <div class="container">
355
+ <p class="pull-right">
356
+ <a href="#">Back to top</a>
357
+
358
+ </p>
359
+ <p>
360
+ &copy; Copyright 2016, E.S.R.Labs AG.<br/>
361
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
362
+ </p>
363
+ </div>
364
+ </footer>
365
+ </body>
366
366
  </html>