RubyGems - bake-toolkit - Versions diffs - 1.0.24 → 1.0.25 - Mend

bake-toolkit 1.0.24 → 1.0.25

Files changed (38) hide show

checksums.yaml +7 -0
data/bin/bake-doc +12 -0
data/doc/cmd/install.html +78 -0
data/doc/cmd/mount.png +0 -0
data/doc/cmd/ruby.png +0 -0
data/doc/cmd/tty.png +0 -0
data/doc/cmd/usecmd.html +56 -0
data/doc/cmd/usecygwin.html +49 -0
data/doc/concepts/buildhierarchy.html +42 -0
data/doc/concepts/configfile.html +102 -0
data/doc/concepts/hier.png +0 -0
data/doc/concepts/mainproject.html +87 -0
data/doc/dyk/keys.png +0 -0
data/doc/dyk/tipps.html +51 -0
data/doc/eclipse/export.html +39 -0
data/doc/eclipse/import.html +29 -0
data/doc/eclipse/install.html +26 -0
data/doc/eclipse/new.html +17 -0
data/doc/eclipse/use.html +56 -0
data/doc/further/change.html +160 -0
data/doc/further/collections.html +21 -0
data/doc/further/internal.html +42 -0
data/doc/further/issues.html +18 -0
data/doc/further/perf.html +54 -0
data/doc/further/wish.html +39 -0
data/doc/index.html +78 -0
data/doc/src/ok.png +0 -0
data/doc/syntax/derive.html +89 -0
data/doc/syntax/subst.html +103 -0
data/doc/syntax/syntax.html +587 -0
data/doc/vs/create.html +16 -0
data/doc/vs/install.html +28 -0
data/doc/vs/use.html +24 -0
data/lib/bake/mergeConfig.rb +108 -0
data/lib/bake/model/metamodel.rb +1 -0
data/lib/bake/version.rb +2 -2
data/lib/tocxx.rb +39 -12
metadata +95 -58

data/doc/dyk/keys.png ADDED Viewed

Binary file

data/doc/dyk/tipps.html ADDED Viewed

@@ -0,0 +1,51 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+<style type="text/css">
+#rundrum {
+  border-width:1px;
+  border-style:dashed;
+  border-color:blue;
+  padding:0.2cm;
+  text-align:justify; }
+}
+</style>
+</head>
+<body>
+<h1>Tipps and Tricks</h1>
+<h3>Syntax highlighting</h3>
+To enable syntax highlighting for the Project.meta files in Eclipse, install the "rtext_eclipse_plugin" (Help->Install New Software...) and associate ".meta" files with the rtext editor (Window->Preferences, File Associations page).<br>
+An update site for Eclipse (needed for installation) will be provided soon. For now, you can download it manually at github.
+<h3>Key bindings</h3>
+It is possible to bind the bake commands to keys.<p>
+<img src="keys.png"/><br>
+<h3>Unnecessary includes</h3>
+If a library or executable is successfully build with "-v", unnecessary includes are printed out:
+<pre id="rundrum"><code>Info: Include to ../sub1/include/ seems to be unnecessary
+Info: Include to ../sub2/include/ seems to be unnecessary</code></pre>
+This features depends on the compiler dependency files. For projects with assembler files, the list might be incorrect.<br>
+However, remove the IncludeDir statements from the Project.meta and check it out.
+<h3>Symlinks and junctions</h3>
+It is possible to use symlinks (Linux) or junctions (Windows) when working with git. Best practice:
+<ul>
+	<li>Link all used projects into <i>one</i> directory (e.g. from application repository and basis software repository).
+	<li>Use this directory when working with bake, Eclipse, etc.
+	<li>Specify "-w <i>absolute_path_to_working_dir</i>.
+    <li>To sync/commit from/to svn, use the original directories created by git.
+</ul>
+<h3>Single file</h3>
+If you want to build a single file, you have to specify it like that:
+<pre id="rundrum"><code>bake -b Debug -f src/abc/MyFile.cpp</pre></code>
+No need to type so much! If it's not ambiguous, it's enough to specify parts of the filename like this:
+<pre id="rundrum"><code>bake -b Debug -f abc/MyFile.cpp
+bake -b Debug -f MyFile.cpp</code></pre>
+</body>
+</html>

data/doc/eclipse/export.html ADDED Viewed

@@ -0,0 +1,39 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+</head>
+<body>
+<h1>How to convert existing CDT workspaces</h1>
+You only need to convert your workspace if CDT is still used to build your projects and the Project.meta files do not exist yet.<br>
+Only <b>one</b> developer in a team has to convert the workspace only <b>once</b>!
+<p>
+Conversion means, that Project.meta files are generated and filled with the informationen from the .project and .cproject files. bake does not read the .project and .cproject files, only the Project.meta files.
+<p>
+The converter is an export wizard, which can be found under "File->Export" or in the context menu of the Project Explorer:<p>
+<img src="export/Select.png"/>
+<img src="export/Script.png"/>
+<p>
+<b>Please note the following things:</b>
+<ul>
+	<li>The conversion is <b>not a 1:1 conversion</b>. That means, that the tool can only be 99% perfect. There might by some small issues, which have to be adapted manually. You can find it out by simply trying to build your project with bake.
+	<li>It is possible to specify a <b>ruby script</b> in the wizard window, which can do these manual adaptions. This can make sense, if you want to convert the workspace several times before completely switching to bake.
+	<li>To convert only a <b>subset of projects</b> instead of the whole workspace, select the appropriate projects in the Project Explorer before starting the export wizard. Ensure that the checkbox shown above is marked.
+    <li>If you are satisfied with the results, <b>replace</b> the .cproject and .project files in your repository.<p>
+	<table border="1">
+	<tr>
+	<td bgcolor="#CCCCCC"> Steps to do with .cproject and .project files </td>
+	</tr>
+	<tr><td>delete the files</td></tr>
+	<tr><td>remove the projects from your workspace in Eclipse (but do not delete the contents from your disk)</td></tr>
+	<tr><td>import the projects again via the bake import wizard to generate wrapper files for Eclipse</td></tr>
+	<tr><td>commit the change to your source control system</td></tr>
+	</table>
+	<p>
+    <b>Do not commit these .project and .cproject files anymore.</b> Instead, commit the changes in Project.meta files.<br>
+    You still need .cproject and .project files for working under Eclipse, that's why you have to import the projects again via the bake import wizard.
+</ul>
+</body>
+</html>

data/doc/eclipse/import.html ADDED Viewed

@@ -0,0 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+</head>
+<body>
+<h1>How to create a workspace in Eclipse </h1>
+<h2>General note</h2>
+Using bake in Eclipse is very similar compared to the CDT build mechanism.
+<p>
+One major difference is, that .cproject and .project files are just wrappers. Do not use the standard property pages, they will be simply ignored! <b>Edit only the Project.meta files.</b><br>
+<b>The .cproject and .project files shall not be committed to your source control.</b>
+However, you may commit .cproject and .project files with an empty dummy configuration <b>once</b> to avoid the following importing step for future checkouts.
+<h2>Import</h2>
+If you have a workspace with no .cproject and .project files, but Project.meta files, you can import them to Eclipse.
+You can also use the importer to import single projects.
+The importer can be found unter File->Import or in the context menu of the Project Explorer.<br>
+All (sub)directories with a Project.meta are listed here. Choose the projects to import and press Finish.<p>
+<img src="import/Select.png"/>
+<img src="import/Import.png"/><br>
+</body>
+</html>

data/doc/eclipse/install.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+</head>
+<body>
+<h1>How to install bake Eclipse integration</h1>
+The bake Eclipse integration plugin is available on a E.S.R.Labs update site. Please follow the steps below to install the plugin.<br>
+<p>
+Go to "Help" -> "Install New Software":<br>
+<img src="install/InstallNewSoftware.png"/><p>
+Setup the update site:<br>
+<img src="install/AddRepository.png"/><p>
+Location:
+<pre><code>http://www.esrlabs.com/eclipse-plugins/com.esrlabs.eclipse.bake.updatesite/</code></pre>
+Choose the bake Feature:<br>
+<img src="install/AvailableSoftware.png"/><p>
+Accept the license after reading it:<br>
+<img src="install/Licenses.png"/><p>
+Ignore the security warning - you can trust the software:<br>
+<img src="install/TrustMe.png"/><p>
+After successfull installation, restart Eclipse:<br>
+<img src="install/Restart.png"/><p>
+</body>
+</html>

data/doc/eclipse/new.html ADDED Viewed

@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+</head>
+<body>
+<h1>How to create a project in Eclipse</h1>
+This is very easy. Navigate to File->New->Other and choose bake Project:<p>
+<img src="new/Select.png"/>
+<img src="new/New.png"/><br>
+Choose a name. If you have more than one workspace root, you can also choose a location.
+<p>
+A new folder with three files will be created. .cproject and .project wrapper files for Eclipse and an almost empty Project.meta which can be filled with build configurations:<p>
+<img src="new/Result.png"/>
+</body>
+</html>

data/doc/eclipse/use.html ADDED Viewed

@@ -0,0 +1,56 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+</head>
+<body>
+<h1>How to use bake in Eclipse</h1>
+<h2>Choose the C/C++ perspective</h2>
+The menu items described on this page only appear in the C/C++ perspective.
+<h2>Select a build configuration of the main project</h2>
+Right click on the main project and select a bake build configuration. Note, that only configurations with a DefaultToolchain will be displayed.<p>
+<img src="select/FirstSelect.png"/><p>
+If no Project.meta or configuration with a DefaultToolchain exist, an error item will be displayed like this:<p>
+<img src="select/WrongSelect.png"/><p>
+The chosen config is marked with a filled circle before the config name.You can also see it directly in the project explorer:<p>
+<img src="select/SecondSelect.png"/><p>
+<p>
+This label decoration can be switched off and on via Window->Preferences->General->Appearance->Label Decorations.
+<h2>Adjust includes for CDT</h2>
+As you might have already seen, a new menu item for the main project is enabled now: Adjust includes for CDT.<br>
+All CDT features work out-of-the-box except those about the #include statements e.g. auto-completion of includes. To import the "bake includes" into the CDT .cproject files, simply click on this menu item.<br>
+<b>This is not a must, it's just convenience.</b><br>
+Note: importing can take between a few seconds and a minute depending on the size of the workspace and the number of project settings which have to be written.<br>
+<h2>Build/Clean Projects/Files</h2>
+Now you can build or clean a project by clicking on the appropriate menu items.<p>
+<table border="1">
+  <tr>
+    <th bgcolor="#CCCCCC">Project</th>
+	<th bgcolor="#CCCCCC">File (note: Build File always rebuilds the file)</th>
+  </tr>
+  <tr>
+    <td><img src="build/buildMain.png"/></td>
+    <td><img src="build/buildFile.png"/></td>
+  </tr>
+</table>
+<h2>Result</h2>
+The result of the build will be shown in the Console and Problems View as usual:<p>
+<img src="build/console.png"/><p>
+<img src="build/problem.png"/><br>
+<h2>Preferences</h2>
+Via Window->Preferences->bake some settings can be changed and the bake command line can be extended:<p>
+<img src="misc/pref.png"/>
+</body>
+</html>

data/doc/further/change.html ADDED Viewed

@@ -0,0 +1,160 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+</head>
+<body>
+<h1>Changelog</h1>
+January 21, 2014 - bake-toolkit 1.0.25<br>
+<ul>
+<li><b>Added: configs can now be inherited</b>
+<li><b>Changed: dependency files for Greenhills compiler will be generated with -MD instead of -MMD</b>
+</ul>
+September 10, 2013 - bake-toolkit 1.0.24<br>
+<ul>
+<li><b>Changed: Improved Keil linker error parser.</b>
+</ul>
+September 9, 2013 - bake-toolkit 1.0.23<br>
+<ul>
+<li><b>Added: Keil support.</b>
+<li><b>Bugfix: minor fixes.</b>
+</ul>
+August 21, 2013 - bake-toolkit 1.0.22<br>
+<ul>
+<li><b>Bugfix: Searching for project folders did not work correctly.</b>
+</ul>
+August 20, 2013 - Eclipse plugin 1.0.5.0<br>
+<ul>
+<li><b>Bugfix: Adjust includes in CDT is working again after Java Update.</b>
+</ul>
+August 1, 2013 - bake-toolkit 1.0.21<br>
+<ul>
+<li><b>Bugfix: projects folders which are junctions were not found anymore after the last update.</b>
+</ul>
+July 25, 2013 - bake-toolkit 1.0.20, Eclipse plugin 1.0.4.0<br>
+<ul>
+<li><b>Added: projects can be placed more than one level below workspaces roots</b>
+</ul>
+June 21, 2013 - bake-toolkit 1.0.19<br>
+<ul>
+<li><b>Added: support for GreenHills compiler.</b>
+</ul>
+May 29, 2013 - bake-toolkit 1.0.18<br>
+<ul>
+<li><b>Bugfix: typo in require, which has broken bake in case sensitive file systems.</b>
+</ul>
+May 28, 2013 - bake-toolkit 1.0.17<br>
+<ul>
+<li><b>Bugfix: error levels greater than 255 of external processes were not be recognized correctly in some cases.</b>
+</ul>
+May 16, 2013 - Eclipse plugin 1.0.2.0<br>
+<ul>
+<li><b>Bugfix: bake did not start correctly with latest Java version installed.</b>
+</ul>
+April 22, 2013 - bake-toolkit 1.0.16<br>
+<ul>
+<li><b>Changed: default roots of bakery are now directory of Collection.meta and it's parent directory.</b>
+</ul>
+April 19, 2013 - bake-toolkit 1.0.15<br>
+<ul>
+<li><b>Bugfix: bakery could not build projects with spaces in oathname.</b>
+</ul>
+April 19, 2013 - bake-toolkit 1.0.13<br>
+<ul>
+<li><b>Bugfix: some bake options specified on bakery command line were not accepted.</b>
+</ul>
+April 17, 2013 - bake-toolkit 1.0.12<br>
+<ul>
+<li><b>Changed: Output folders are not deleted and rebuilt if no source files are available but the archive file.</b>
+<li><b>Added: Option --clobber deletes .bake cache file.</b>
+<li><b>Added: Collections can reference collections.</b>
+<li><b>Added: collection names can be specified without typing "-b"</b>
+</ul>
+April 4, 2013 - bake-toolkit 1.0.11<br>
+<ul>
+<li><b>Bugfix: Executing batch files in CommandLine on Windows were broken.</b>
+</ul>
+April 2, 2013 - bake-toolkit 1.0.10<br>
+<ul>
+<li><b>Bugfix: options "--toolchain_names" now working as intended</b>
+<li><b>Bugfix: default flags for makefiles (-j) no longer ignored</b>
+<li><b>Changed: flags for makefiles are now defined in subtags instead in attributes to be consistent with other flag definitions</b>
+<li><b>Added: ".." in Files and ExcludeFiles now allowed</b>
+<li><b>Added: command line switch to turn off "directory magic"</b>
+<li><b>Added: build config can be specified without typing "-b"</b>
+<li><b>Cosmetic: better error output if compiler not found</b>
+</ul>
+March 22, 2013 - bake-toolkit 1.0.9<br>
+<ul>
+<li><b>Cosmetic: Changed option --print_less to -v0 and -v to -v2. Default is -v1.</b>
+</ul>
+March 7, 2013 - bake-toolkit 1.0.8<br>
+<ul>
+<li><b>Added: Linkerscript can be referenced from other projects</b>
+</ul>
+February 13, 2013 - bake-toolkit 1.0.7<br>
+<ul>
+<li><b>Added: OS dependent variable $(/)</b>
+</ul>
+January 21, 2013 - bake-toolkit 1.0.6<br>
+<ul>
+<li><b>Added: support for Visual Studio</b>
+</ul>
+January 15, 2013 - bake-toolkit 1.0.5<br>
+<ul>
+<li><b>Changed: no indirect dependency to progressbar gem anymore</b>
+</ul>
+January 14, 2013 - bake-toolkit 1.0.4<br>
+<ul>
+<li><b>Added: a new cache validation check.</b>
+</ul>
+January 2, 2013 - bake-toolkit 1.0.3<br>
+<ul>
+<li><b>Bugfix: option to build a single file did not accept a filename with absolute path.</b>
+</ul>
+October 7, 2012 - bake-toolkit 1.0.2<br>
+<ul>
+<li><b>Changed: Renamed gem from "bake" to "bake-toolkit".</b>
+</ul>
+September 18, 2012 - bake 1.0.1<br>
+<ul>
+<li><b>Changed: bake now based on rgen 0.6.0 and rtext 0.2.0, which are available on rubygems.</b>
+</ul>
+August 31, 2012 - bake 1.0.0<br>
+<ul>
+<li><b>First official release</b>
+</ul>
+<table>
+</body>
+</html>

data/doc/further/collections.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+</head>
+<body>
+<h1>bakery</h1>
+<ul>
+<li>bakery is part of the bake-toolkit distribution and it is used to build several independent projects at once.
+<li>It's very useful for e.g. compiling and running all unit tests.
+<li>The collections are specified in Collection.meta files.
+</ul>
+<h2>Guidelines</h2>
+<ul>
+<li><a href="bakery/cmd.html">How to use bakery on command line</a><br>
+<li><a href="bakery/syntax.html">Syntax of Collection.meta</a>
+</ul>
+</body>
+</html>

data/doc/further/internal.html ADDED Viewed

@@ -0,0 +1,42 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Documentation of the bake-tookit</title>
+</head>
+<body>
+<h1>Internal developing notes</h1>
+<h2>Socket</h2>
+If command line option --socket is used, bake tries to connect to the given port on localhost.
+<h3>send</h3>
+<h4>Header</h4>
+1 Byte: Type<br>
+4 Byte: Length (used to discard the paket if type is unknown to the listening application)<br>
+<h4>Error packet (type 0x01)</h4>
+4 Byte: Length filename, project name<br>
+x Byte: filename, project name<br>
+4 Byte: line number (can be 0)<br>
+1 Byte: severity (0x00 = info, 0x01 = warning, 0x02 = error, 0xFF = ok)<br>
+x Byte: message (length = rest of packet)<br>
+<h4>Starting build packet (type 0x0A)</h4>
+4 Byte: Length project name<br>
+x Byte: project name<br>
+4 Byte: Length config name<br>
+x Byte: config name<br>
+4 Byte: number of projects in this build (greater than 0)<br>
+<h4>Building project packet</h4>
+Same as Starting build packet, except number of projects = 0<br>
+<h3>receive</h3>
+If a byte is received, the build will be aborted.
+</body>
+</html>