RubyGems - bake-toolkit - Versions diffs - 2.29.4 → 2.30.0 - Mend

bake-toolkit 2.29.4 → 2.30.0

Files changed (300) hide show

data/documentation/_build/html/concepts/prebuild.html DELETED Viewed

@@ -1,206 +0,0 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Prebuild configurations for distributions &mdash; bake documentation</title>
-    <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/bootswatch-3.3.4/sandstone/bootstrap.min.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
-    <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
-    <script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
-    <script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
-    <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
-    <link rel="shortcut icon" href="../_static/logo_tiny_32.ico"/>
-    <link rel="top" title="bake documentation" href="../index.html" />
-    <link rel="up" title="Concepts" href="concepts.html" />
-    <link rel="next" title="Injection and inheritance of IncludeDir and Dependency" href="inject.html" />
-    <link rel="prev" title="The link order" href="link_order.html" />
-<meta charset='utf-8'>
-<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
-<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
-<meta name="apple-mobile-web-app-capable" content="yes">
-  </head>
-  <body role="document">
-  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
-    <div class="container">
-      <div class="navbar-header">
-        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
-        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-        </button>
-        <a class="navbar-brand" href="../index.html"><img src="../_static/logo_tiny_48.png">
-           </a>
-        <span class="navbar-text navbar-version pull-left"><b></b></span>
-      </div>
-        <div class="collapse navbar-collapse nav-collapse">
-          <ul class="nav navbar-nav">
-              <li class="dropdown globaltoc-container">
-  <a role="button"
-     id="dLabelGlobalToc"
-     data-toggle="dropdown"
-     data-target="#"
-     href="../index.html">Section <b class="caret"></b></a>
-  <ul class="dropdown-menu globaltoc"
-      role="menu"
-      aria-labelledby="dLabelGlobalToc"><ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../why_bake/why_bake.html">Why you should use bake</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../install/install_bake.html">Install bake</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/quickstart.html">Quickstart</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="concepts.html">Concepts</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../syntax/syntax.html">Syntax</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../commandline/commandline.html">Commandline</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../ide/ide_integrations.html">IDE Support</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../tips_and_tricks/tips_and_tricks.html">Additional features</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../performance/performance.html">Performance</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../known_issues.html">Known Issues</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
-</ul>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../internal.html">Internal developing notes</a></li>
-</ul>
-</ul>
-</li>
-                <li class="dropdown">
-  <a role="button"
-     id="dLabelLocalToc"
-     data-toggle="dropdown"
-     data-target="#"
-     href="#">SubSections <b class="caret"></b></a>
-  <ul class="dropdown-menu localtoc"
-      role="menu"
-      aria-labelledby="dLabelLocalToc"><ul>
-<li><a class="reference internal" href="#">Prebuild configurations for distributions</a><ul>
-<li><a class="reference internal" href="#typical-workflow">Typical workflow</a></li>
-</ul>
-</li>
-</ul>
-</ul>
-</li>
-  <li>
-    <a href="link_order.html" title="Previous Chapter: The link order"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; The link order</span>
-    </a>
-  </li>
-  <li>
-    <a href="inject.html" title="Next Chapter: Injection and inheritance of IncludeDir and Dependency"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Injection and... &raquo;</span>
-    </a>
-  </li>
-          </ul>
-<form class="navbar-form navbar-right" action="../search.html" method="get">
- <div class="form-group">
-  <input type="text" name="q" class="form-control" placeholder="Search" />
- </div>
-  <input type="hidden" name="check_keywords" value="yes" />
-  <input type="hidden" name="area" value="default" />
-</form>
-        </div>
-    </div>
-  </div>
-<div class="container">
-  <div class="row">
-    <div class="col-md-12">
-  <div class="section" id="prebuild-configurations-for-distributions">
-<h1>Prebuild configurations for distributions<a class="headerlink" href="#prebuild-configurations-for-distributions" title="Permalink to this headline">¶</a></h1>
-<p>This is a useful feature if you want to make a part of workspace available for third party without changing the configuration.</p>
-<p>There are two major use cases:</p>
-<ul class="simple">
-<li>Only a few projects shall be closed source (e.g. to hide some algorithms)</li>
-<li>Only a few projects shall be open source (e.g. if a supplier has integrate a library)</li>
-</ul>
-<p>Both is possible with bake, but the current UI is optimized for the latter one.</p>
-<p>Add in the Project.meta the following code:</p>
-<div class="highlight-console"><div class="highlight"><pre><span class="go">Prebuild {</span>
-<span class="go">  Except main, config: Debug</span>
-<span class="go">  Except newLib, config: Debug</span>
-<span class="go">  Except setup, config: Release</span>
-<span class="go">}</span>
-</pre></div>
-</div>
-<p>It is possible to specify the Prebuild tags in all configurations, not only in the main configuration. Logically they will be merged.</p>
-<p>In the example above, no configurations will be built - except those three. The prebuild output is used directly.</p>
-<p>To reference a configuration of the same project, omit the project name, e.g.:</p>
-<div class="highlight-console"><div class="highlight"><pre><span class="go">Except config: Base</span>
-</pre></div>
-</div>
-<p>To reference all configuration of a project, omit the config name, e.g.:</p>
-<div class="highlight-console"><div class="highlight"><pre><span class="go">Except newLib</span>
-</pre></div>
-</div>
-<p>This prebuild behaviour must be explicitly turned on by using the following the command line argument:</p>
-<div class="highlight-console"><div class="highlight"><pre><span class="go">--prebuild</span>
-</pre></div>
-</div>
-<p>Note, that if objects files exist, the library will be built from existing object files (glob for *.o in appropriate build folder). If only the archive exists, the archive will be used without building it.</p>
-<div class="section" id="typical-workflow">
-<h2>Typical workflow<a class="headerlink" href="#typical-workflow" title="Permalink to this headline">¶</a></h2>
-<ol class="arabic simple">
-<li>Compiling the workspace completely without prebuild feature.</li>
-<li>Executing a distribution script which copies all relevant files to a distribution directory.
-Make sure to add all header files of prebuild libraries if they are needed for other non-prebuild libraries.
-You may use the dependency files in the output directory for that script.</li>
-<li>In the distribution folder use &#8220;&#8211;prebuild&#8221; when compiling the workspace.</li>
-</ol>
-</div>
-</div>
-    </div>
-  </div>
-</div>
-<footer class="footer">
-  <div class="container">
-    <p class="pull-right">
-      <a href="#">Back to top</a>
-    </p>
-    <p>
-        &copy; Copyright 2016, E.S.R.Labs AG.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
-    </p>
-  </div>
-</footer>
-  </body>
-</html>

data/documentation/_build/html/concepts/the_main_project.html DELETED Viewed

@@ -1,261 +0,0 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>The main project &mdash; bake documentation</title>
-    <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/bootswatch-3.3.4/sandstone/bootstrap.min.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
-      };
-    </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
-    <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
-    <script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
-    <script type="text/javascript" src="../_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
-    <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
-    <link rel="shortcut icon" href="../_static/logo_tiny_32.ico"/>
-    <link rel="top" title="bake documentation" href="../index.html" />
-    <link rel="up" title="Concepts" href="concepts.html" />
-    <link rel="next" title="The build hierarchy" href="build_hierarchy.html" />
-    <link rel="prev" title="The Project.meta file" href="the_project_meta_file.html" />
-<meta charset='utf-8'>
-<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
-<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
-<meta name="apple-mobile-web-app-capable" content="yes">
-  </head>
-  <body role="document">
-  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
-    <div class="container">
-      <div class="navbar-header">
-        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
-        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-        </button>
-        <a class="navbar-brand" href="../index.html"><img src="../_static/logo_tiny_48.png">
-           </a>
-        <span class="navbar-text navbar-version pull-left"><b></b></span>
-      </div>
-        <div class="collapse navbar-collapse nav-collapse">
-          <ul class="nav navbar-nav">
-              <li class="dropdown globaltoc-container">
-  <a role="button"
-     id="dLabelGlobalToc"
-     data-toggle="dropdown"
-     data-target="#"
-     href="../index.html">Section <b class="caret"></b></a>
-  <ul class="dropdown-menu globaltoc"
-      role="menu"
-      aria-labelledby="dLabelGlobalToc"><ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../why_bake/why_bake.html">Why you should use bake</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../install/install_bake.html">Install bake</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/quickstart.html">Quickstart</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="concepts.html">Concepts</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../syntax/syntax.html">Syntax</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../commandline/commandline.html">Commandline</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../ide/ide_integrations.html">IDE Support</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../tips_and_tricks/tips_and_tricks.html">Additional features</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../performance/performance.html">Performance</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../known_issues.html">Known Issues</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
-</ul>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../internal.html">Internal developing notes</a></li>
-</ul>
-</ul>
-</li>
-                <li class="dropdown">
-  <a role="button"
-     id="dLabelLocalToc"
-     data-toggle="dropdown"
-     data-target="#"
-     href="#">SubSections <b class="caret"></b></a>
-  <ul class="dropdown-menu localtoc"
-      role="menu"
-      aria-labelledby="dLabelLocalToc"><ul>
-<li><a class="reference internal" href="#">The main project</a><ul>
-<li><a class="reference internal" href="#advantages">Advantages</a></li>
-<li><a class="reference internal" href="#example">Example</a></li>
-<li><a class="reference internal" href="#output-directory">Output directory</a></li>
-</ul>
-</li>
-</ul>
-</ul>
-</li>
-  <li>
-    <a href="the_project_meta_file.html" title="Previous Chapter: The Project.meta file"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; The Project.m...</span>
-    </a>
-  </li>
-  <li>
-    <a href="build_hierarchy.html" title="Next Chapter: The build hierarchy"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">The build hie... &raquo;</span>
-    </a>
-  </li>
-          </ul>
-<form class="navbar-form navbar-right" action="../search.html" method="get">
- <div class="form-group">
-  <input type="text" name="q" class="form-control" placeholder="Search" />
- </div>
-  <input type="hidden" name="check_keywords" value="yes" />
-  <input type="hidden" name="area" value="default" />
-</form>
-        </div>
-    </div>
-  </div>
-<div class="container">
-  <div class="row">
-    <div class="col-md-12">
-  <div class="section" id="the-main-project">
-<h1>The main project<a class="headerlink" href="#the-main-project" title="Permalink to this headline">¶</a></h1>
-<p>The concept of the main project is different to many other build systems like Eclipse CDT.
-In these build systems everything which is needed for a project is configured in the project itself.
-In bake the main project can predefine stuff for all subprojects.
-The main project can have a DefaultToolchain definition, which is valid for all projects and files referenced by the main project. Subprojects can overwrite or adjust these definitions.</p>
-<p>Projects are always built in context of the main project.</p>
-<p>To build a project, you have to specify</p>
-<blockquote>
-<div><ul class="simple">
-<li>the main project</li>
-<li>the config of the main project which references the project to build</li>
-<li>the (sub)project to build if applicable</li>
-</ul>
-</div></blockquote>
-<div class="section" id="advantages">
-<h2>Advantages<a class="headerlink" href="#advantages" title="Permalink to this headline">¶</a></h2>
-<p>Reducing the number of build configurations (toolchain settings like debug or release flags can be set outside of the project)
-Most projects do not have any compiler definitions anymore
-Only flags which must be used or flags which must not be used have to be specified in the projects
-Changing compiler definitions for all projects can be done easily in the main project build configuration</p>
-</div>
-<div class="section" id="example">
-<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
-<table border="1" class="docutils">
-<colgroup>
-<col width="50%" />
-<col width="50%" />
-</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Project.meta of Main (Debug and Release)</th>
-<th class="head">Project.meta of Sub (only one build config!)</th>
-</tr>
-</thead>
-<tbody valign="top">
-<tr class="row-even"><td><div class="first last highlight-python"><div class="highlight"><pre>Project {
-    ExecutableConfig Debug {
-        Dependency Sub, config: Lib
-        Files &quot;**/*.cpp&quot;
-        IncludeDir &quot;include&quot;
-        DefaultToolchain GCC {
-            Compiler CPP {
-                Flags &quot;... whatever -debug_info&quot;
-                Define &quot;DEBUG&quot;
-            }
-        }
-    }
-    ExecutableConfig Release {
-        Dependency Sub, config: Lib
-        Files &quot;**/*.cpp&quot;
-        IncludeDir &quot;include&quot;
-        DefaultToolchain GCC {
-            Compiler CPP {
-                Flags &quot;... whatever -optimize&quot;
-                Define &quot;NDEBUG&quot;
-            }
-        }
-    }
-}
-</pre></div>
-</div>
-</td>
-<td><div class="first last highlight-python"><div class="highlight"><pre>Project {
-    LibraryConfig Lib {
-        Files &quot;**/*.cpp&quot;
-        IncludeDir &quot;include&quot;
-    }
-}
-</pre></div>
-</div>
-</td>
-</tr>
-</tbody>
-</table>
-<div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">A main project must have a DefaultToolchain - but it&#8217;s allowed to leave that definition empty.</p>
-</div>
-</div>
-<div class="section" id="output-directory">
-<h2>Output directory<a class="headerlink" href="#output-directory" title="Permalink to this headline">¶</a></h2>
-<p>A project in a specific build configuration can be build in different contexts.
-That&#8217;s why the output directory of a project cannot be simply the build configuration name of the project to avoid inconsistencies.
-Therefore the output directory names are.</p>
-<blockquote>
-<div><ul class="simple">
-<li>Main project: $(MainConfigName) like in regular Eclipse CDT builds</li>
-<li>Subprojects: $(MainConfigName)_$(MainProjectName) instead of the config name of the subproject</li>
-</ul>
-</div></blockquote>
-</div>
-</div>
-    </div>
-  </div>
-</div>
-<footer class="footer">
-  <div class="container">
-    <p class="pull-right">
-      <a href="#">Back to top</a>
-    </p>
-    <p>
-        &copy; Copyright 2016, E.S.R.Labs AG.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.<br/>
-    </p>
-  </div>
-</footer>
-  </body>
-</html>