bake-toolkit 2.20.4 → 2.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Rakefile.rb +3 -3
- data/bin/bake +46 -46
- data/bin/bake-doc +11 -11
- data/bin/bakery +179 -179
- data/bin/createVSProjects +213 -213
- data/documentation/_build/html/_sources/changelog.txt +456 -451
- data/documentation/_build/html/_sources/commandline/commandline.txt +107 -107
- data/documentation/_build/html/_sources/concepts/build_hierarchy.txt +34 -34
- data/documentation/_build/html/_sources/concepts/concepts.txt +14 -14
- data/documentation/_build/html/_sources/concepts/inject.txt +65 -65
- data/documentation/_build/html/_sources/concepts/link_order.txt +91 -91
- data/documentation/_build/html/_sources/concepts/prebuild.txt +56 -56
- data/documentation/_build/html/_sources/concepts/the_main_project.txt +45 -45
- data/documentation/_build/html/_sources/concepts/the_project_meta_file.txt +72 -72
- data/documentation/_build/html/_sources/ide/eclipse/eclipse.txt +25 -25
- data/documentation/_build/html/_sources/ide/eclipse/how_to_convert_existing_cdt_workspace.txt +31 -31
- data/documentation/_build/html/_sources/ide/eclipse/how_to_create_a_new_project_in_eclipse.txt +18 -18
- data/documentation/_build/html/_sources/ide/eclipse/how_to_create_a_workspace_in_eclipse.txt +27 -27
- data/documentation/_build/html/_sources/ide/eclipse/how_to_debug_in_eclipse.txt +38 -38
- data/documentation/_build/html/_sources/ide/eclipse/how_to_install_eclipse_plugin.txt +44 -44
- data/documentation/_build/html/_sources/ide/eclipse/how_to_use_bake_in_eclipse.txt +86 -86
- data/documentation/_build/html/_sources/ide/ide_integrations.txt +8 -8
- data/documentation/_build/html/_sources/ide/vs/how_to_create_vs_projects.txt +15 -15
- data/documentation/_build/html/_sources/ide/vs/how_to_debug_in_vs.txt +35 -35
- data/documentation/_build/html/_sources/ide/vs/how_to_used_bake_in_vs.txt +35 -35
- data/documentation/_build/html/_sources/ide/vs/vs.txt +10 -10
- data/documentation/_build/html/_sources/ide/vs/vs_install.txt +43 -43
- data/documentation/_build/html/_sources/index.txt +33 -33
- data/documentation/_build/html/_sources/install/install_bake.txt +112 -112
- data/documentation/_build/html/_sources/internal.txt +50 -50
- data/documentation/_build/html/_sources/known_issues.txt +9 -9
- data/documentation/_build/html/_sources/license.txt +4 -4
- data/documentation/_build/html/_sources/performance/performance.txt +104 -104
- data/documentation/_build/html/_sources/quickstart/quickstart.txt +70 -70
- data/documentation/_build/html/_sources/syntax/adapt_configs.txt +143 -143
- data/documentation/_build/html/_sources/syntax/auto_adjustment.txt +43 -43
- data/documentation/_build/html/_sources/syntax/derive_configs.txt +93 -94
- data/documentation/_build/html/_sources/syntax/project_meta_syntax.txt +19 -19
- data/documentation/_build/html/_sources/syntax/syntax.txt +11 -11
- data/documentation/_build/html/_sources/syntax/variable_substitutions.txt +147 -147
- data/documentation/_build/html/_sources/tips_and_tricks/dot.txt +34 -34
- data/documentation/_build/html/_sources/tips_and_tricks/how_to_use_bake_with_cygwin.txt +62 -62
- data/documentation/_build/html/_sources/tips_and_tricks/static_code_analysis.txt +122 -122
- data/documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt +72 -72
- data/documentation/_build/html/_sources/tips_and_tricks/the_clang.txt +43 -43
- data/documentation/_build/html/_sources/tips_and_tricks/tips_and_tricks.txt +34 -34
- data/documentation/_build/html/_sources/why_bake/why_bake.txt +40 -40
- data/documentation/_build/html/changelog.html +7 -0
- data/documentation/_build/html/commandline/commandline.html +2 -2
- data/documentation/_build/html/concepts/link_order.html +2 -2
- data/documentation/_build/html/concepts/prebuild.html +2 -2
- data/documentation/_build/html/index.html +4 -4
- data/documentation/_build/html/performance/performance.html +2 -2
- data/documentation/_build/html/searchindex.js +1 -1
- data/documentation/_build/html/syntax/adapt_configs.html +2 -2
- data/documentation/_build/html/syntax/syntax.html +2 -2
- data/documentation/_build/html/tips_and_tricks/the_clang.html +2 -2
- data/documentation/_build/html/why_bake/why_bake.html +2 -2
- data/lib/adapt/config/loader.rb +112 -112
- data/lib/bake/bundle.rb +158 -158
- data/lib/bake/cache.rb +179 -180
- data/lib/bake/config/checks.rb +68 -68
- data/lib/bake/config/loader.rb +363 -363
- data/lib/bake/libElement.rb +176 -176
- data/lib/bake/mergeConfig.rb +208 -208
- data/lib/bake/model/language.rb +45 -45
- data/lib/bake/model/loader.rb +99 -99
- data/lib/bake/model/metamodel.rb +307 -307
- data/lib/bake/model/metamodel_ext.rb +27 -27
- data/lib/bake/options/create.rb +95 -95
- data/lib/bake/options/options.rb +315 -310
- data/lib/bake/options/showDoc.rb +20 -20
- data/lib/bake/options/showLicense.rb +9 -9
- data/lib/bake/options/showToolchains.rb +38 -38
- data/lib/bake/options/usage.rb +79 -68
- data/lib/bake/subst.rb +313 -313
- data/lib/bake/toolchain/clang.rb +44 -44
- data/lib/bake/toolchain/clang_analyze.rb +31 -31
- data/lib/bake/toolchain/colorizing_formatter.rb +125 -125
- data/lib/bake/toolchain/diab.rb +53 -53
- data/lib/bake/toolchain/errorparser/diab_compiler_error_parser.rb +40 -40
- data/lib/bake/toolchain/errorparser/diab_linker_error_parser.rb +41 -41
- data/lib/bake/toolchain/errorparser/error_parser.rb +71 -71
- data/lib/bake/toolchain/errorparser/gcc_compiler_error_parser.rb +35 -35
- data/lib/bake/toolchain/errorparser/gcc_linker_error_parser.rb +35 -35
- data/lib/bake/toolchain/errorparser/greenhills_compiler_error_parser.rb +32 -32
- data/lib/bake/toolchain/errorparser/greenhills_linker_error_parser.rb +44 -44
- data/lib/bake/toolchain/errorparser/keil_compiler_error_parser.rb +40 -40
- data/lib/bake/toolchain/errorparser/keil_linker_error_parser.rb +30 -30
- data/lib/bake/toolchain/errorparser/lint_error_parser.rb +34 -34
- data/lib/bake/toolchain/errorparser/msvc_compiler_error_parser.rb +63 -63
- data/lib/bake/toolchain/errorparser/msvc_linker_error_parser.rb +42 -42
- data/lib/bake/toolchain/errorparser/process_output.rb +2 -2
- data/lib/bake/toolchain/errorparser/ti_compiler_error_parser.rb +30 -30
- data/lib/bake/toolchain/errorparser/ti_linker_error_parser.rb +30 -30
- data/lib/bake/toolchain/gcc.rb +49 -49
- data/lib/bake/toolchain/gcc_env.rb +55 -55
- data/lib/bake/toolchain/greenhills.rb +52 -52
- data/lib/bake/toolchain/keil.rb +53 -53
- data/lib/bake/toolchain/lint.rb +20 -20
- data/lib/bake/toolchain/msvc.rb +58 -58
- data/lib/bake/toolchain/provider.rb +146 -146
- data/lib/bake/toolchain/ti.rb +47 -47
- data/lib/bake/util.rb +149 -149
- data/lib/bakery/buildPattern.rb +24 -24
- data/lib/bakery/model/language.rb +22 -22
- data/lib/bakery/model/loader.rb +55 -55
- data/lib/bakery/model/metamodel.rb +48 -48
- data/lib/bakery/options/options.rb +87 -87
- data/lib/bakery/toBake.rb +81 -81
- data/lib/blocks/block.rb +324 -324
- data/lib/blocks/blockBase.rb +204 -204
- data/lib/blocks/commandLine.rb +38 -38
- data/lib/blocks/compile.rb +529 -528
- data/lib/blocks/convert.rb +41 -41
- data/lib/blocks/docu.rb +30 -30
- data/lib/blocks/executable.rb +174 -174
- data/lib/blocks/has_execute_command.rb +31 -31
- data/lib/blocks/library.rb +114 -114
- data/lib/blocks/lint.rb +56 -56
- data/lib/blocks/makefile.rb +100 -100
- data/lib/blocks/showIncludes.rb +140 -125
- data/lib/common/abortException.rb +4 -4
- data/lib/common/cleanup.rb +10 -10
- data/lib/common/exit_helper.rb +38 -38
- data/lib/common/ext/file.rb +88 -88
- data/lib/common/ext/rtext.rb +11 -11
- data/lib/common/ext/stdout.rb +45 -45
- data/lib/common/ide_interface.rb +194 -194
- data/lib/common/options/parser.rb +95 -85
- data/lib/common/process.rb +64 -64
- data/lib/common/utils.rb +52 -52
- data/lib/common/version.rb +31 -23
- data/lib/multithread/job.rb +44 -44
- data/lib/tocxx.rb +558 -555
- data/lib/vs/options.rb +69 -69
- data/license.txt +90 -90
- metadata +2 -2
@@ -1,15 +1,15 @@
|
|
1
|
-
How to create VS-Projects using bake
|
2
|
-
====================================
|
3
|
-
|
4
|
-
bake projects are Makefile projects (NMake). When creating a new project, you can just create a new Makefile project and add a Project.meta.
|
5
|
-
The recommended way is to use a script which comes with bake-toolkit:
|
6
|
-
|
7
|
-
.. image:: ../../_static/cvsp.png
|
8
|
-
:width: 100 %
|
9
|
-
:scale: 50 %
|
10
|
-
|
11
|
-
Example:
|
12
|
-
|
13
|
-
.. code-block:: console
|
14
|
-
|
15
|
-
C:\MyProj> createVSProjects --version 2012 --rewrite
|
1
|
+
How to create VS-Projects using bake
|
2
|
+
====================================
|
3
|
+
|
4
|
+
bake projects are Makefile projects (NMake). When creating a new project, you can just create a new Makefile project and add a Project.meta.
|
5
|
+
The recommended way is to use a script which comes with bake-toolkit:
|
6
|
+
|
7
|
+
.. image:: ../../_static/cvsp.png
|
8
|
+
:width: 100 %
|
9
|
+
:scale: 50 %
|
10
|
+
|
11
|
+
Example:
|
12
|
+
|
13
|
+
.. code-block:: console
|
14
|
+
|
15
|
+
C:\MyProj> createVSProjects --version 2012 --rewrite
|
@@ -1,35 +1,35 @@
|
|
1
|
-
How to Debug in Visual Studio
|
2
|
-
=============================
|
3
|
-
|
4
|
-
Natively you can only debug the output from the Microsoft VC compiler with Visual Studio. There are some plugins available for e.g. debugging gcc output. Another option is to use the MSVC toolchain from bake, which is described on this help page.
|
5
|
-
Add debug flags to the MSVC toolchain:
|
6
|
-
|
7
|
-
|
8
|
-
.. code-block:: text
|
9
|
-
|
10
|
-
DefaultToolchain MSVC {
|
11
|
-
|
12
|
-
Compiler CPP {
|
13
|
-
Flags "-Zi"
|
14
|
-
}
|
15
|
-
Linker {
|
16
|
-
Flags "-Debug"
|
17
|
-
}
|
18
|
-
}
|
19
|
-
|
20
|
-
Start Visual Studio with e.g. a batch file shown below and choose the appropriate solution. If you don't have a solution yet, check out How to create a solution / projects in Visual Studio.
|
21
|
-
|
22
|
-
.. code-block:: console
|
23
|
-
|
24
|
-
set PATH=%PATH%;C:\tools\Microsoft Visual Studio 11.0\VC\bin
|
25
|
-
call "C:\tools\Microsoft Visual Studio 11.0\VC\vcvarsall.bat"
|
26
|
-
"C:\tools\Microsoft Visual Studio 11.0\Common7\IDE\devenv.exe"
|
27
|
-
|
28
|
-
This adds the compiler, linker, etc. to the path. vcvarsall.bat setups the environment and the last line starts Visual Studio. As a test, just execute the first two lines and check if "cl.exe" can be executed without any errors. In Visual Studio, you have to define the executable you like to debug. Add the executable in the project properties:
|
29
|
-
|
30
|
-
.. image:: ../../_static/vs_debug.png
|
31
|
-
:width: 100 %
|
32
|
-
:scale: 50 %
|
33
|
-
|
34
|
-
You can also define command line arguments here.
|
35
|
-
Start debugging as usual...
|
1
|
+
How to Debug in Visual Studio
|
2
|
+
=============================
|
3
|
+
|
4
|
+
Natively you can only debug the output from the Microsoft VC compiler with Visual Studio. There are some plugins available for e.g. debugging gcc output. Another option is to use the MSVC toolchain from bake, which is described on this help page.
|
5
|
+
Add debug flags to the MSVC toolchain:
|
6
|
+
|
7
|
+
|
8
|
+
.. code-block:: text
|
9
|
+
|
10
|
+
DefaultToolchain MSVC {
|
11
|
+
|
12
|
+
Compiler CPP {
|
13
|
+
Flags "-Zi"
|
14
|
+
}
|
15
|
+
Linker {
|
16
|
+
Flags "-Debug"
|
17
|
+
}
|
18
|
+
}
|
19
|
+
|
20
|
+
Start Visual Studio with e.g. a batch file shown below and choose the appropriate solution. If you don't have a solution yet, check out How to create a solution / projects in Visual Studio.
|
21
|
+
|
22
|
+
.. code-block:: console
|
23
|
+
|
24
|
+
set PATH=%PATH%;C:\tools\Microsoft Visual Studio 11.0\VC\bin
|
25
|
+
call "C:\tools\Microsoft Visual Studio 11.0\VC\vcvarsall.bat"
|
26
|
+
"C:\tools\Microsoft Visual Studio 11.0\Common7\IDE\devenv.exe"
|
27
|
+
|
28
|
+
This adds the compiler, linker, etc. to the path. vcvarsall.bat setups the environment and the last line starts Visual Studio. As a test, just execute the first two lines and check if "cl.exe" can be executed without any errors. In Visual Studio, you have to define the executable you like to debug. Add the executable in the project properties:
|
29
|
+
|
30
|
+
.. image:: ../../_static/vs_debug.png
|
31
|
+
:width: 100 %
|
32
|
+
:scale: 50 %
|
33
|
+
|
34
|
+
You can also define command line arguments here.
|
35
|
+
Start debugging as usual...
|
@@ -1,35 +1,35 @@
|
|
1
|
-
How to use bake in Visual Studio
|
2
|
-
================================
|
3
|
-
|
4
|
-
#. Select a build configuration of the main project
|
5
|
-
|
6
|
-
Right click on the main project and select a bake build configuration.
|
7
|
-
|
8
|
-
.. image:: ../../_static/vs_select_config.png
|
9
|
-
:width: 100 %
|
10
|
-
:scale: 50 %
|
11
|
-
|
12
|
-
.. note::
|
13
|
-
|
14
|
-
Only configurations with a DefaultToolchain will be displayed.
|
15
|
-
|
16
|
-
#. You can see the selected config in the last line of the Build menu.
|
17
|
-
|
18
|
-
.. image:: ../../_static/vs_show_config.png
|
19
|
-
:width: 100 %
|
20
|
-
:scale: 50 %
|
21
|
-
|
22
|
-
If you click on this menu item, you can deselect the build config, which disables bake as long as no other config will be selected.
|
23
|
-
|
24
|
-
#. You can specify additional command line parameters via the Options menu.
|
25
|
-
|
26
|
-
.. image:: ../../_static/vs_options.png
|
27
|
-
:width: 100 %
|
28
|
-
:scale: 50 %
|
29
|
-
|
30
|
-
#. The build result will be shown in the Output window, errors will be shown in the Error window and annotated in the sources.
|
31
|
-
|
32
|
-
.. image:: ../../_static/vs_error.png
|
33
|
-
:width: 100 %
|
34
|
-
:scale: 50 %
|
35
|
-
|
1
|
+
How to use bake in Visual Studio
|
2
|
+
================================
|
3
|
+
|
4
|
+
#. Select a build configuration of the main project
|
5
|
+
|
6
|
+
Right click on the main project and select a bake build configuration.
|
7
|
+
|
8
|
+
.. image:: ../../_static/vs_select_config.png
|
9
|
+
:width: 100 %
|
10
|
+
:scale: 50 %
|
11
|
+
|
12
|
+
.. note::
|
13
|
+
|
14
|
+
Only configurations with a DefaultToolchain will be displayed.
|
15
|
+
|
16
|
+
#. You can see the selected config in the last line of the Build menu.
|
17
|
+
|
18
|
+
.. image:: ../../_static/vs_show_config.png
|
19
|
+
:width: 100 %
|
20
|
+
:scale: 50 %
|
21
|
+
|
22
|
+
If you click on this menu item, you can deselect the build config, which disables bake as long as no other config will be selected.
|
23
|
+
|
24
|
+
#. You can specify additional command line parameters via the Options menu.
|
25
|
+
|
26
|
+
.. image:: ../../_static/vs_options.png
|
27
|
+
:width: 100 %
|
28
|
+
:scale: 50 %
|
29
|
+
|
30
|
+
#. The build result will be shown in the Output window, errors will be shown in the Error window and annotated in the sources.
|
31
|
+
|
32
|
+
.. image:: ../../_static/vs_error.png
|
33
|
+
:width: 100 %
|
34
|
+
:scale: 50 %
|
35
|
+
|
@@ -1,10 +1,10 @@
|
|
1
|
-
Visual Studio
|
2
|
-
=============
|
3
|
-
|
4
|
-
.. toctree::
|
5
|
-
:maxdepth: 1
|
6
|
-
|
7
|
-
vs_install
|
8
|
-
how_to_used_bake_in_vs
|
9
|
-
how_to_create_vs_projects
|
10
|
-
how_to_debug_in_vs
|
1
|
+
Visual Studio
|
2
|
+
=============
|
3
|
+
|
4
|
+
.. toctree::
|
5
|
+
:maxdepth: 1
|
6
|
+
|
7
|
+
vs_install
|
8
|
+
how_to_used_bake_in_vs
|
9
|
+
how_to_create_vs_projects
|
10
|
+
how_to_debug_in_vs
|
@@ -1,43 +1,43 @@
|
|
1
|
-
How to install bake Visual Studio integration
|
2
|
-
=============================================
|
3
|
-
|
4
|
-
VS 2012
|
5
|
-
*******
|
6
|
-
The plugin is available on a E.S.R.Labs update site. Please follow the steps below to install the plugin.
|
7
|
-
|
8
|
-
#. Configure the update site
|
9
|
-
|
10
|
-
`<http://www.esrlabs.com/vs-plugins/bake/atom.xml>`_
|
11
|
-
|
12
|
-
.. image:: ../../_static/vs_update_site.png
|
13
|
-
:width: 100 %
|
14
|
-
:scale: 50 %
|
15
|
-
|
16
|
-
#. Now it's available via Tools->Extensions and Updates
|
17
|
-
|
18
|
-
.. image:: ../../_static/vs_install1.png
|
19
|
-
:width: 100 %
|
20
|
-
:scale: 50 %
|
21
|
-
|
22
|
-
#. Check if it's installed correctly
|
23
|
-
|
24
|
-
.. image:: ../../_static/vs_installed.png
|
25
|
-
:width: 100 %
|
26
|
-
:scale: 50 %
|
27
|
-
|
28
|
-
#. If an update is available, it will look like this
|
29
|
-
|
30
|
-
.. image:: ../../_static/vs_update.png
|
31
|
-
:width: 100 %
|
32
|
-
:scale: 50 %
|
33
|
-
|
34
|
-
VS 2010
|
35
|
-
*******
|
36
|
-
|
37
|
-
The plugin is available on a E.S.R.Labs server.
|
38
|
-
Download `Visual Studio 2010 bake plugin <http://www.esrlabs.com/vs-plugins/bake/bake%20Visual%20Studio%20Extension%202010.vsix>`_,
|
39
|
-
double click the file and install it.
|
40
|
-
|
41
|
-
.. image:: ../../_static/vs_2010_install.png
|
42
|
-
:width: 100 %
|
43
|
-
:scale: 50 %
|
1
|
+
How to install bake Visual Studio integration
|
2
|
+
=============================================
|
3
|
+
|
4
|
+
VS 2012
|
5
|
+
*******
|
6
|
+
The plugin is available on a E.S.R.Labs update site. Please follow the steps below to install the plugin.
|
7
|
+
|
8
|
+
#. Configure the update site
|
9
|
+
|
10
|
+
`<http://www.esrlabs.com/vs-plugins/bake/atom.xml>`_
|
11
|
+
|
12
|
+
.. image:: ../../_static/vs_update_site.png
|
13
|
+
:width: 100 %
|
14
|
+
:scale: 50 %
|
15
|
+
|
16
|
+
#. Now it's available via Tools->Extensions and Updates
|
17
|
+
|
18
|
+
.. image:: ../../_static/vs_install1.png
|
19
|
+
:width: 100 %
|
20
|
+
:scale: 50 %
|
21
|
+
|
22
|
+
#. Check if it's installed correctly
|
23
|
+
|
24
|
+
.. image:: ../../_static/vs_installed.png
|
25
|
+
:width: 100 %
|
26
|
+
:scale: 50 %
|
27
|
+
|
28
|
+
#. If an update is available, it will look like this
|
29
|
+
|
30
|
+
.. image:: ../../_static/vs_update.png
|
31
|
+
:width: 100 %
|
32
|
+
:scale: 50 %
|
33
|
+
|
34
|
+
VS 2010
|
35
|
+
*******
|
36
|
+
|
37
|
+
The plugin is available on a E.S.R.Labs server.
|
38
|
+
Download `Visual Studio 2010 bake plugin <http://www.esrlabs.com/vs-plugins/bake/bake%20Visual%20Studio%20Extension%202010.vsix>`_,
|
39
|
+
double click the file and install it.
|
40
|
+
|
41
|
+
.. image:: ../../_static/vs_2010_install.png
|
42
|
+
:width: 100 %
|
43
|
+
:scale: 50 %
|
@@ -1,33 +1,33 @@
|
|
1
|
-
bake 2.
|
2
|
-
==========================================
|
3
|
-
bake, building software **fast** and **easy**!
|
4
|
-
|
5
|
-
======================================= =======================================
|
6
|
-
\ \
|
7
|
-
======================================= =======================================
|
8
|
-
.. image:: _static/bake_tagcloud.png **Start to bake**
|
9
|
-
|
10
|
-
.. toctree::
|
11
|
-
:maxdepth: 2
|
12
|
-
|
13
|
-
why_bake/why_bake
|
14
|
-
install/install_bake
|
15
|
-
quickstart/quickstart
|
16
|
-
concepts/concepts
|
17
|
-
syntax/syntax
|
18
|
-
commandline/commandline
|
19
|
-
ide/ide_integrations
|
20
|
-
tips_and_tricks/tips_and_tricks
|
21
|
-
performance/performance
|
22
|
-
known_issues
|
23
|
-
changelog
|
24
|
-
license
|
25
|
-
|
26
|
-
.. toctree::
|
27
|
-
:maxdepth: 1
|
28
|
-
|
29
|
-
internal
|
30
|
-
======================================= =======================================
|
31
|
-
|
32
|
-
|
33
|
-
|
1
|
+
bake 2.21.0
|
2
|
+
==========================================
|
3
|
+
bake, building software **fast** and **easy**!
|
4
|
+
|
5
|
+
======================================= =======================================
|
6
|
+
\ \
|
7
|
+
======================================= =======================================
|
8
|
+
.. image:: _static/bake_tagcloud.png **Start to bake**
|
9
|
+
|
10
|
+
.. toctree::
|
11
|
+
:maxdepth: 2
|
12
|
+
|
13
|
+
why_bake/why_bake
|
14
|
+
install/install_bake
|
15
|
+
quickstart/quickstart
|
16
|
+
concepts/concepts
|
17
|
+
syntax/syntax
|
18
|
+
commandline/commandline
|
19
|
+
ide/ide_integrations
|
20
|
+
tips_and_tricks/tips_and_tricks
|
21
|
+
performance/performance
|
22
|
+
known_issues
|
23
|
+
changelog
|
24
|
+
license
|
25
|
+
|
26
|
+
.. toctree::
|
27
|
+
:maxdepth: 1
|
28
|
+
|
29
|
+
internal
|
30
|
+
======================================= =======================================
|
31
|
+
|
32
|
+
|
33
|
+
|
@@ -1,112 +1,112 @@
|
|
1
|
-
Install bake
|
2
|
-
============
|
3
|
-
|
4
|
-
bake is a `ruby gem <https://rubygems.org/>`_. It runs with `Ruby <https://www.ruby-lang.org/en/>`_ **>= 1.9**.
|
5
|
-
bake and its depedencies can be found on `rubygems <https://rubygems.org/gems/bake-toolkit/>`_, which is configured as ruby source per default.
|
6
|
-
|
7
|
-
.. attention::
|
8
|
-
|
9
|
-
The actual name of the bake gem is `bake-toolkit <https://rubygems.org/gems/bake-toolkit/>`_.
|
10
|
-
|
11
|
-
How to install bake
|
12
|
-
*******************
|
13
|
-
Installing bake is very easy!
|
14
|
-
|
15
|
-
#. Make sure you have installed `Ruby <https://www.ruby-lang.org/en/>`_ **>= 1.9**.
|
16
|
-
|
17
|
-
#. Istall the bake gem.
|
18
|
-
|
19
|
-
.. code-block:: console
|
20
|
-
|
21
|
-
User@Host:~$ gem install bake-toolkit
|
22
|
-
|
23
|
-
Example
|
24
|
-
-------
|
25
|
-
|
26
|
-
.. code-block:: console
|
27
|
-
|
28
|
-
User@Host:~$ ruby -v # (Check if an apropriate ruby version is installed)
|
29
|
-
ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]
|
30
|
-
|
31
|
-
User@Host:~$ gem install bake-toolkit # (Install the bake gem)
|
32
|
-
Fetching: highline-1.6.15.gem (100%)
|
33
|
-
Fetching: colored-1.2.gem (100%)
|
34
|
-
Fetching: progressbar-0.11.0.gem (100%)
|
35
|
-
Fetching: rgen-0.6.0.gem (100%)
|
36
|
-
Fetching: rtext-0.2.0.gem (100%)
|
37
|
-
Fetching: bake-toolkit-1.0.2.gem (100%)
|
38
|
-
Successfully installed highline-1.6.15
|
39
|
-
Successfully installed colored-1.2
|
40
|
-
Successfully installed progressbar-0.11.0
|
41
|
-
Successfully installed rgen-0.6.0
|
42
|
-
Successfully installed rtext-0.2.0
|
43
|
-
Successfully installed bake-toolkit-1.0.2
|
44
|
-
7 gems installed
|
45
|
-
Installing ri documentation for highline-1.6.15...
|
46
|
-
Installing ri documentation for colored-1.2...
|
47
|
-
Installing ri documentation for progressbar-0.11.0...
|
48
|
-
Installing ri documentation for rgen-0.6.0...
|
49
|
-
Installing ri documentation for rtext-0.2.0...
|
50
|
-
Installing ri documentation for bake-toolkit-1.0.2...
|
51
|
-
Installing RDoc documentation for highline-1.6.15...
|
52
|
-
Installing RDoc documentation for colored-1.2...
|
53
|
-
Installing RDoc documentation for progressbar-0.11.0...
|
54
|
-
Installing RDoc documentation for rgen-0.6.0...
|
55
|
-
Installing RDoc documentation for rtext-0.2.0...
|
56
|
-
Installing RDoc documentation for bake-toolkit-1.0.2...
|
57
|
-
|
58
|
-
|
59
|
-
Known Issues
|
60
|
-
************
|
61
|
-
|
62
|
-
The installation does not start
|
63
|
-
-------------------------------
|
64
|
-
**Issue:**
|
65
|
-
The installation of the bake gem does not start.
|
66
|
-
(This is often caused by a password protected internat proxy.)
|
67
|
-
|
68
|
-
|
69
|
-
**Solution:**
|
70
|
-
|
71
|
-
* Check your network connection.
|
72
|
-
* Unlock the password protected proxy by opening an external webpage (e.g. `google <https://www.google.com>`_) using your web browser.
|
73
|
-
|
74
|
-
|
75
|
-
Invalid Language Settings
|
76
|
-
-------------------------
|
77
|
-
*Issue:**
|
78
|
-
The error parsers in bake assume English language.
|
79
|
-
|
80
|
-
**Solution:**
|
81
|
-
|
82
|
-
Adjust your language settings e.g by setting the environment variable **LC_ALL**.
|
83
|
-
|
84
|
-
Example:
|
85
|
-
|
86
|
-
.. code-block:: console
|
87
|
-
|
88
|
-
LC_ALL=en_US
|
89
|
-
|
90
|
-
.. note::
|
91
|
-
|
92
|
-
Depending on the system and the compiler the way how to change the language might be different.
|
93
|
-
|
94
|
-
Error Message During the installation
|
95
|
-
-------------------------------------
|
96
|
-
**Issue:**
|
97
|
-
Ruby throws an error during the installation.
|
98
|
-
|
99
|
-
**Solution:**
|
100
|
-
Usualy you will see an error like this:
|
101
|
-
|
102
|
-
.. code-block:: console
|
103
|
-
|
104
|
-
ERROR: While generating documentation for ...
|
105
|
-
... MESSAGE: Error while evaluating ...
|
106
|
-
undefined method `gsub' for nil:NilClass ...
|
107
|
-
|
108
|
-
This is a ruby bug. However, the gems were installed correctly. You can avoid building the documentation by installing bake like this:
|
109
|
-
|
110
|
-
.. code-block:: console
|
111
|
-
|
112
|
-
User@Host:~$ gem install bake-toolkit --no-rdoc --no-ri
|
1
|
+
Install bake
|
2
|
+
============
|
3
|
+
|
4
|
+
bake is a `ruby gem <https://rubygems.org/>`_. It runs with `Ruby <https://www.ruby-lang.org/en/>`_ **>= 1.9**.
|
5
|
+
bake and its depedencies can be found on `rubygems <https://rubygems.org/gems/bake-toolkit/>`_, which is configured as ruby source per default.
|
6
|
+
|
7
|
+
.. attention::
|
8
|
+
|
9
|
+
The actual name of the bake gem is `bake-toolkit <https://rubygems.org/gems/bake-toolkit/>`_.
|
10
|
+
|
11
|
+
How to install bake
|
12
|
+
*******************
|
13
|
+
Installing bake is very easy!
|
14
|
+
|
15
|
+
#. Make sure you have installed `Ruby <https://www.ruby-lang.org/en/>`_ **>= 1.9**.
|
16
|
+
|
17
|
+
#. Istall the bake gem.
|
18
|
+
|
19
|
+
.. code-block:: console
|
20
|
+
|
21
|
+
User@Host:~$ gem install bake-toolkit
|
22
|
+
|
23
|
+
Example
|
24
|
+
-------
|
25
|
+
|
26
|
+
.. code-block:: console
|
27
|
+
|
28
|
+
User@Host:~$ ruby -v # (Check if an apropriate ruby version is installed)
|
29
|
+
ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]
|
30
|
+
|
31
|
+
User@Host:~$ gem install bake-toolkit # (Install the bake gem)
|
32
|
+
Fetching: highline-1.6.15.gem (100%)
|
33
|
+
Fetching: colored-1.2.gem (100%)
|
34
|
+
Fetching: progressbar-0.11.0.gem (100%)
|
35
|
+
Fetching: rgen-0.6.0.gem (100%)
|
36
|
+
Fetching: rtext-0.2.0.gem (100%)
|
37
|
+
Fetching: bake-toolkit-1.0.2.gem (100%)
|
38
|
+
Successfully installed highline-1.6.15
|
39
|
+
Successfully installed colored-1.2
|
40
|
+
Successfully installed progressbar-0.11.0
|
41
|
+
Successfully installed rgen-0.6.0
|
42
|
+
Successfully installed rtext-0.2.0
|
43
|
+
Successfully installed bake-toolkit-1.0.2
|
44
|
+
7 gems installed
|
45
|
+
Installing ri documentation for highline-1.6.15...
|
46
|
+
Installing ri documentation for colored-1.2...
|
47
|
+
Installing ri documentation for progressbar-0.11.0...
|
48
|
+
Installing ri documentation for rgen-0.6.0...
|
49
|
+
Installing ri documentation for rtext-0.2.0...
|
50
|
+
Installing ri documentation for bake-toolkit-1.0.2...
|
51
|
+
Installing RDoc documentation for highline-1.6.15...
|
52
|
+
Installing RDoc documentation for colored-1.2...
|
53
|
+
Installing RDoc documentation for progressbar-0.11.0...
|
54
|
+
Installing RDoc documentation for rgen-0.6.0...
|
55
|
+
Installing RDoc documentation for rtext-0.2.0...
|
56
|
+
Installing RDoc documentation for bake-toolkit-1.0.2...
|
57
|
+
|
58
|
+
|
59
|
+
Known Issues
|
60
|
+
************
|
61
|
+
|
62
|
+
The installation does not start
|
63
|
+
-------------------------------
|
64
|
+
**Issue:**
|
65
|
+
The installation of the bake gem does not start.
|
66
|
+
(This is often caused by a password protected internat proxy.)
|
67
|
+
|
68
|
+
|
69
|
+
**Solution:**
|
70
|
+
|
71
|
+
* Check your network connection.
|
72
|
+
* Unlock the password protected proxy by opening an external webpage (e.g. `google <https://www.google.com>`_) using your web browser.
|
73
|
+
|
74
|
+
|
75
|
+
Invalid Language Settings
|
76
|
+
-------------------------
|
77
|
+
*Issue:**
|
78
|
+
The error parsers in bake assume English language.
|
79
|
+
|
80
|
+
**Solution:**
|
81
|
+
|
82
|
+
Adjust your language settings e.g by setting the environment variable **LC_ALL**.
|
83
|
+
|
84
|
+
Example:
|
85
|
+
|
86
|
+
.. code-block:: console
|
87
|
+
|
88
|
+
LC_ALL=en_US
|
89
|
+
|
90
|
+
.. note::
|
91
|
+
|
92
|
+
Depending on the system and the compiler the way how to change the language might be different.
|
93
|
+
|
94
|
+
Error Message During the installation
|
95
|
+
-------------------------------------
|
96
|
+
**Issue:**
|
97
|
+
Ruby throws an error during the installation.
|
98
|
+
|
99
|
+
**Solution:**
|
100
|
+
Usualy you will see an error like this:
|
101
|
+
|
102
|
+
.. code-block:: console
|
103
|
+
|
104
|
+
ERROR: While generating documentation for ...
|
105
|
+
... MESSAGE: Error while evaluating ...
|
106
|
+
undefined method `gsub' for nil:NilClass ...
|
107
|
+
|
108
|
+
This is a ruby bug. However, the gems were installed correctly. You can avoid building the documentation by installing bake like this:
|
109
|
+
|
110
|
+
.. code-block:: console
|
111
|
+
|
112
|
+
User@Host:~$ gem install bake-toolkit --no-rdoc --no-ri
|