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
data/documentation/_build/html/install/install_bake.html CHANGED
@@ -1,280 +1,280 @@
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>Install bake &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="Quickstart" href="../quickstart/quickstart.html" />
34
- <link rel="prev" title="Why you should use bake" href="../why_bake/why_bake.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 current"><a class="current reference internal" href="">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"><a class="reference internal" href="../syntax/syntax.html">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="#">Install bake</a><ul>
99
- <li><a class="reference internal" href="#how-to-install-bake">How to install bake</a><ul>
100
- <li><a class="reference internal" href="#example">Example</a></li>
101
- </ul>
102
- </li>
103
- <li><a class="reference internal" href="#known-issues">Known Issues</a><ul>
104
- <li><a class="reference internal" href="#the-installation-does-not-start">The installation does not start</a></li>
105
- <li><a class="reference internal" href="#invalid-language-settings">Invalid Language Settings</a></li>
106
- <li><a class="reference internal" href="#error-message-during-the-installation">Error Message During the installation</a></li>
107
- </ul>
108
- </li>
109
- </ul>
110
- </li>
111
- </ul>
112
- </ul>
113
- </li>
114
-
115
-
116
-
117
-
118
-
119
- <li>
120
- <a href="../why_bake/why_bake.html" title="Previous Chapter: Why you should use bake"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Why you shoul...</span>
121
- </a>
122
- </li>
123
- <li>
124
- <a href="../quickstart/quickstart.html" title="Next Chapter: Quickstart"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Quickstart &raquo;</span>
125
- </a>
126
- </li>
127
-
128
-
129
-
130
-
131
-
132
- </ul>
133
-
134
-
135
-
136
- <form class="navbar-form navbar-right" action="../search.html" method="get">
137
- <div class="form-group">
138
- <input type="text" name="q" class="form-control" placeholder="Search" />
139
- </div>
140
- <input type="hidden" name="check_keywords" value="yes" />
141
- <input type="hidden" name="area" value="default" />
142
- </form>
143
-
144
- </div>
145
- </div>
146
- </div>
147
-
148
- <div class="container">
149
- <div class="row">
150
- <div class="col-md-12">
151
-
152
- <div class="section" id="install-bake">
153
- <h1>Install bake<a class="headerlink" href="#install-bake" title="Permalink to this headline">¶</a></h1>
154
- <p>bake is a <a class="reference external" href="https://rubygems.org/">ruby gem</a>. It runs with <a class="reference external" href="https://www.ruby-lang.org/en/">Ruby</a> <strong>&gt;= 1.9</strong>.
155
- bake and its depedencies can be found on <a class="reference external" href="https://rubygems.org/gems/bake-toolkit/">rubygems</a>, which is configured as ruby source per default.</p>
156
- <div class="admonition attention">
157
- <p class="first admonition-title">Attention</p>
158
- <p class="last">The actual name of the bake gem is <a class="reference external" href="https://rubygems.org/gems/bake-toolkit/">bake-toolkit</a>.</p>
159
- </div>
160
- <div class="section" id="how-to-install-bake">
161
- <h2>How to install bake<a class="headerlink" href="#how-to-install-bake" title="Permalink to this headline">¶</a></h2>
162
- <p>Installing bake is very easy!</p>
163
- <ol class="arabic">
164
- <li><p class="first">Make sure you have installed <a class="reference external" href="https://www.ruby-lang.org/en/">Ruby</a> <strong>&gt;= 1.9</strong>.</p>
165
- </li>
166
- <li><p class="first">Istall the bake gem.</p>
167
- <blockquote>
168
- <div><div class="highlight-console"><div class="highlight"><pre><span class="gp">User@Host:~$</span> gem install bake-toolkit
169
- </pre></div>
170
- </div>
171
- </div></blockquote>
172
- </li>
173
- </ol>
174
- <div class="section" id="example">
175
- <h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
176
- <div class="highlight-console"><div class="highlight"><pre><span class="gp">User@Host:~$</span> ruby -v <span class="c"># (Check if an apropriate ruby version is installed)</span>
177
- <span class="go">ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]</span>
178
-
179
- <span class="gp">User@Host:~$</span> gem install bake-toolkit <span class="c"># (Install the bake gem)</span>
180
- <span class="go">Fetching: highline-1.6.15.gem (100%)</span>
181
- <span class="go">Fetching: colored-1.2.gem (100%)</span>
182
- <span class="go">Fetching: progressbar-0.11.0.gem (100%)</span>
183
- <span class="go">Fetching: rgen-0.6.0.gem (100%)</span>
184
- <span class="go">Fetching: rtext-0.2.0.gem (100%)</span>
185
- <span class="go">Fetching: bake-toolkit-1.0.2.gem (100%)</span>
186
- <span class="go">Successfully installed highline-1.6.15</span>
187
- <span class="go">Successfully installed colored-1.2</span>
188
- <span class="go">Successfully installed progressbar-0.11.0</span>
189
- <span class="go">Successfully installed rgen-0.6.0</span>
190
- <span class="go">Successfully installed rtext-0.2.0</span>
191
- <span class="go">Successfully installed bake-toolkit-1.0.2</span>
192
- <span class="go">7 gems installed</span>
193
- <span class="go">Installing ri documentation for highline-1.6.15...</span>
194
- <span class="go">Installing ri documentation for colored-1.2...</span>
195
- <span class="go">Installing ri documentation for progressbar-0.11.0...</span>
196
- <span class="go">Installing ri documentation for rgen-0.6.0...</span>
197
- <span class="go">Installing ri documentation for rtext-0.2.0...</span>
198
- <span class="go">Installing ri documentation for bake-toolkit-1.0.2...</span>
199
- <span class="go">Installing RDoc documentation for highline-1.6.15...</span>
200
- <span class="go">Installing RDoc documentation for colored-1.2...</span>
201
- <span class="go">Installing RDoc documentation for progressbar-0.11.0...</span>
202
- <span class="go">Installing RDoc documentation for rgen-0.6.0...</span>
203
- <span class="go">Installing RDoc documentation for rtext-0.2.0...</span>
204
- <span class="go">Installing RDoc documentation for bake-toolkit-1.0.2...</span>
205
- </pre></div>
206
- </div>
207
- </div>
208
- </div>
209
- <div class="section" id="known-issues">
210
- <h2>Known Issues<a class="headerlink" href="#known-issues" title="Permalink to this headline">¶</a></h2>
211
- <div class="section" id="the-installation-does-not-start">
212
- <h3>The installation does not start<a class="headerlink" href="#the-installation-does-not-start" title="Permalink to this headline">¶</a></h3>
213
- <p><strong>Issue:</strong>
214
- The installation of the bake gem does not start.
215
- (This is often caused by a password protected internat proxy.)</p>
216
- <p><strong>Solution:</strong></p>
217
- <ul class="simple">
218
- <li>Check your network connection.</li>
219
- <li>Unlock the password protected proxy by opening an external webpage (e.g. <a class="reference external" href="https://www.google.com">google</a>) using your web browser.</li>
220
- </ul>
221
- </div>
222
- <div class="section" id="invalid-language-settings">
223
- <h3>Invalid Language Settings<a class="headerlink" href="#invalid-language-settings" title="Permalink to this headline">¶</a></h3>
224
- <p><em>Issue:*</em>
225
- The error parsers in bake assume English language.</p>
226
- <p><strong>Solution:</strong></p>
227
- <p>Adjust your language settings e.g by setting the environment variable <strong>LC_ALL</strong>.</p>
228
- <p>Example:</p>
229
- <blockquote>
230
- <div><div class="highlight-console"><div class="highlight"><pre><span class="go">LC_ALL=en_US</span>
231
- </pre></div>
232
- </div>
233
- </div></blockquote>
234
- <div class="admonition note">
235
- <p class="first admonition-title">Note</p>
236
- <p class="last">Depending on the system and the compiler the way how to change the language might be different.</p>
237
- </div>
238
- </div>
239
- <div class="section" id="error-message-during-the-installation">
240
- <h3>Error Message During the installation<a class="headerlink" href="#error-message-during-the-installation" title="Permalink to this headline">¶</a></h3>
241
- <p><strong>Issue:</strong>
242
- Ruby throws an error during the installation.</p>
243
- <p><strong>Solution:</strong>
244
- Usualy you will see an error like this:</p>
245
- <blockquote>
246
- <div><div class="highlight-console"><div class="highlight"><pre><span class="go">ERROR: While generating documentation for ...</span>
247
- <span class="go">... MESSAGE: Error while evaluating ...</span>
248
- <span class="go"> undefined method `gsub&#39; for nil:NilClass ...</span>
249
- </pre></div>
250
- </div>
251
- </div></blockquote>
252
- <p>This is a ruby bug. However, the gems were installed correctly. You can avoid building the documentation by installing bake like this:</p>
253
- <blockquote>
254
- <div><div class="highlight-console"><div class="highlight"><pre><span class="gp">User@Host:~$</span> gem install bake-toolkit --no-rdoc --no-ri
255
- </pre></div>
256
- </div>
257
- </div></blockquote>
258
- </div>
259
- </div>
260
- </div>
261
-
262
-
263
- </div>
264
-
265
- </div>
266
- </div>
267
- <footer class="footer">
268
- <div class="container">
269
- <p class="pull-right">
270
- <a href="#">Back to top</a>
271
-
272
- </p>
273
- <p>
274
- &copy; Copyright 2016, E.S.R.Labs AG.<br/>
275
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
276
- </p>
277
- </div>
278
- </footer>
279
- </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>Install bake &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="Quickstart" href="../quickstart/quickstart.html" />
34
+ <link rel="prev" title="Why you should use bake" href="../why_bake/why_bake.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 current"><a class="current reference internal" href="">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"><a class="reference internal" href="../syntax/syntax.html">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="#">Install bake</a><ul>
99
+ <li><a class="reference internal" href="#how-to-install-bake">How to install bake</a><ul>
100
+ <li><a class="reference internal" href="#example">Example</a></li>
101
+ </ul>
102
+ </li>
103
+ <li><a class="reference internal" href="#known-issues">Known Issues</a><ul>
104
+ <li><a class="reference internal" href="#the-installation-does-not-start">The installation does not start</a></li>
105
+ <li><a class="reference internal" href="#invalid-language-settings">Invalid Language Settings</a></li>
106
+ <li><a class="reference internal" href="#error-message-during-the-installation">Error Message During the installation</a></li>
107
+ </ul>
108
+ </li>
109
+ </ul>
110
+ </li>
111
+ </ul>
112
+ </ul>
113
+ </li>
114
+
115
+
116
+
117
+
118
+
119
+ <li>
120
+ <a href="../why_bake/why_bake.html" title="Previous Chapter: Why you should use bake"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Why you shoul...</span>
121
+ </a>
122
+ </li>
123
+ <li>
124
+ <a href="../quickstart/quickstart.html" title="Next Chapter: Quickstart"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Quickstart &raquo;</span>
125
+ </a>
126
+ </li>
127
+
128
+
129
+
130
+
131
+
132
+ </ul>
133
+
134
+
135
+
136
+ <form class="navbar-form navbar-right" action="../search.html" method="get">
137
+ <div class="form-group">
138
+ <input type="text" name="q" class="form-control" placeholder="Search" />
139
+ </div>
140
+ <input type="hidden" name="check_keywords" value="yes" />
141
+ <input type="hidden" name="area" value="default" />
142
+ </form>
143
+
144
+ </div>
145
+ </div>
146
+ </div>
147
+
148
+ <div class="container">
149
+ <div class="row">
150
+ <div class="col-md-12">
151
+
152
+ <div class="section" id="install-bake">
153
+ <h1>Install bake<a class="headerlink" href="#install-bake" title="Permalink to this headline">¶</a></h1>
154
+ <p>bake is a <a class="reference external" href="https://rubygems.org/">ruby gem</a>. It runs with <a class="reference external" href="https://www.ruby-lang.org/en/">Ruby</a> <strong>&gt;= 1.9</strong>.
155
+ bake and its depedencies can be found on <a class="reference external" href="https://rubygems.org/gems/bake-toolkit/">rubygems</a>, which is configured as ruby source per default.</p>
156
+ <div class="admonition attention">
157
+ <p class="first admonition-title">Attention</p>
158
+ <p class="last">The actual name of the bake gem is <a class="reference external" href="https://rubygems.org/gems/bake-toolkit/">bake-toolkit</a>.</p>
159
+ </div>
160
+ <div class="section" id="how-to-install-bake">
161
+ <h2>How to install bake<a class="headerlink" href="#how-to-install-bake" title="Permalink to this headline">¶</a></h2>
162
+ <p>Installing bake is very easy!</p>
163
+ <ol class="arabic">
164
+ <li><p class="first">Make sure you have installed <a class="reference external" href="https://www.ruby-lang.org/en/">Ruby</a> <strong>&gt;= 1.9</strong>.</p>
165
+ </li>
166
+ <li><p class="first">Istall the bake gem.</p>
167
+ <blockquote>
168
+ <div><div class="highlight-console"><div class="highlight"><pre><span class="gp">User@Host:~$</span> gem install bake-toolkit
169
+ </pre></div>
170
+ </div>
171
+ </div></blockquote>
172
+ </li>
173
+ </ol>
174
+ <div class="section" id="example">
175
+ <h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
176
+ <div class="highlight-console"><div class="highlight"><pre><span class="gp">User@Host:~$</span> ruby -v <span class="c"># (Check if an apropriate ruby version is installed)</span>
177
+ <span class="go">ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]</span>
178
+
179
+ <span class="gp">User@Host:~$</span> gem install bake-toolkit <span class="c"># (Install the bake gem)</span>
180
+ <span class="go">Fetching: highline-1.6.15.gem (100%)</span>
181
+ <span class="go">Fetching: colored-1.2.gem (100%)</span>
182
+ <span class="go">Fetching: progressbar-0.11.0.gem (100%)</span>
183
+ <span class="go">Fetching: rgen-0.6.0.gem (100%)</span>
184
+ <span class="go">Fetching: rtext-0.2.0.gem (100%)</span>
185
+ <span class="go">Fetching: bake-toolkit-1.0.2.gem (100%)</span>
186
+ <span class="go">Successfully installed highline-1.6.15</span>
187
+ <span class="go">Successfully installed colored-1.2</span>
188
+ <span class="go">Successfully installed progressbar-0.11.0</span>
189
+ <span class="go">Successfully installed rgen-0.6.0</span>
190
+ <span class="go">Successfully installed rtext-0.2.0</span>
191
+ <span class="go">Successfully installed bake-toolkit-1.0.2</span>
192
+ <span class="go">7 gems installed</span>
193
+ <span class="go">Installing ri documentation for highline-1.6.15...</span>
194
+ <span class="go">Installing ri documentation for colored-1.2...</span>
195
+ <span class="go">Installing ri documentation for progressbar-0.11.0...</span>
196
+ <span class="go">Installing ri documentation for rgen-0.6.0...</span>
197
+ <span class="go">Installing ri documentation for rtext-0.2.0...</span>
198
+ <span class="go">Installing ri documentation for bake-toolkit-1.0.2...</span>
199
+ <span class="go">Installing RDoc documentation for highline-1.6.15...</span>
200
+ <span class="go">Installing RDoc documentation for colored-1.2...</span>
201
+ <span class="go">Installing RDoc documentation for progressbar-0.11.0...</span>
202
+ <span class="go">Installing RDoc documentation for rgen-0.6.0...</span>
203
+ <span class="go">Installing RDoc documentation for rtext-0.2.0...</span>
204
+ <span class="go">Installing RDoc documentation for bake-toolkit-1.0.2...</span>
205
+ </pre></div>
206
+ </div>
207
+ </div>
208
+ </div>
209
+ <div class="section" id="known-issues">
210
+ <h2>Known Issues<a class="headerlink" href="#known-issues" title="Permalink to this headline">¶</a></h2>
211
+ <div class="section" id="the-installation-does-not-start">
212
+ <h3>The installation does not start<a class="headerlink" href="#the-installation-does-not-start" title="Permalink to this headline">¶</a></h3>
213
+ <p><strong>Issue:</strong>
214
+ The installation of the bake gem does not start.
215
+ (This is often caused by a password protected internat proxy.)</p>
216
+ <p><strong>Solution:</strong></p>
217
+ <ul class="simple">
218
+ <li>Check your network connection.</li>
219
+ <li>Unlock the password protected proxy by opening an external webpage (e.g. <a class="reference external" href="https://www.google.com">google</a>) using your web browser.</li>
220
+ </ul>
221
+ </div>
222
+ <div class="section" id="invalid-language-settings">
223
+ <h3>Invalid Language Settings<a class="headerlink" href="#invalid-language-settings" title="Permalink to this headline">¶</a></h3>
224
+ <p><em>Issue:*</em>
225
+ The error parsers in bake assume English language.</p>
226
+ <p><strong>Solution:</strong></p>
227
+ <p>Adjust your language settings e.g by setting the environment variable <strong>LC_ALL</strong>.</p>
228
+ <p>Example:</p>
229
+ <blockquote>
230
+ <div><div class="highlight-console"><div class="highlight"><pre><span class="go">LC_ALL=en_US</span>
231
+ </pre></div>
232
+ </div>
233
+ </div></blockquote>
234
+ <div class="admonition note">
235
+ <p class="first admonition-title">Note</p>
236
+ <p class="last">Depending on the system and the compiler the way how to change the language might be different.</p>
237
+ </div>
238
+ </div>
239
+ <div class="section" id="error-message-during-the-installation">
240
+ <h3>Error Message During the installation<a class="headerlink" href="#error-message-during-the-installation" title="Permalink to this headline">¶</a></h3>
241
+ <p><strong>Issue:</strong>
242
+ Ruby throws an error during the installation.</p>
243
+ <p><strong>Solution:</strong>
244
+ Usualy you will see an error like this:</p>
245
+ <blockquote>
246
+ <div><div class="highlight-console"><div class="highlight"><pre><span class="go">ERROR: While generating documentation for ...</span>
247
+ <span class="go">... MESSAGE: Error while evaluating ...</span>
248
+ <span class="go"> undefined method `gsub&#39; for nil:NilClass ...</span>
249
+ </pre></div>
250
+ </div>
251
+ </div></blockquote>
252
+ <p>This is a ruby bug. However, the gems were installed correctly. You can avoid building the documentation by installing bake like this:</p>
253
+ <blockquote>
254
+ <div><div class="highlight-console"><div class="highlight"><pre><span class="gp">User@Host:~$</span> gem install bake-toolkit --no-rdoc --no-ri
255
+ </pre></div>
256
+ </div>
257
+ </div></blockquote>
258
+ </div>
259
+ </div>
260
+ </div>
261
+
262
+
263
+ </div>
264
+
265
+ </div>
266
+ </div>
267
+ <footer class="footer">
268
+ <div class="container">
269
+ <p class="pull-right">
270
+ <a href="#">Back to top</a>
271
+
272
+ </p>
273
+ <p>
274
+ &copy; Copyright 2016, E.S.R.Labs AG.<br/>
275
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
276
+ </p>
277
+ </div>
278
+ </footer>
279
+ </body>
280
280
  </html>