bake-toolkit 2.27.0 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0e1f90912811da36dbf1370d42792187d92ad06
-  data.tar.gz: f3b95ad81adb8298b0ac6bbc2efd1527a797a276
+  metadata.gz: 1aa0177faf2f9d0cd91e59c197ae0735405be5e2
+  data.tar.gz: 0b07115194a535a57b70a67b53afe0f7bf54923d
 SHA512:
-  metadata.gz: 189d2546359dcd6469d9780f70d753c73875f4ed382697e3ea9214fc139f3c10aece6baa9ffac3f54dfd824a4e14e4bb926a01e8756d1e4bdfd10e031d2de9e4
-  data.tar.gz: d10fa61a1f6e25b653f8c778e3a58cb6e06e5e2a1f839429100b7ebc1aecd77266d423faffd565446b5228ed3e9d775c55e1171f24e70d26f8ce3f7fe73bd4e6
+  metadata.gz: 142f89f22e3a82d3e115cb0b0067d2744ed39362b41f67b19ac288df71cd2c779c4b15111a981d2ba1075e58c29eb3fd6a284808e3fea5f1351af2dee7eea846
+  data.tar.gz: 1732477174d2f3d279218ed5ea46dcf2cfc4887d155d7a3cd16f7ba50f940a1962723be624447edfad2bd9bc85e1854b2f9b25c9dddd3388493f2847fbf72d79

data/bin/bakeqac

@@ -33,7 +33,7 @@ def self.checkCipSize()
   return false
 end
 
-def self.executeQacli(cmd, immediateOutput = false)
+def self.executeQacli(cmd, adminStepAndImmediateOutput = false)
   timeStart = Time.now
   cSizeCheck = true
   licenseError = false
@@ -41,7 +41,8 @@ def self.executeQacli(cmd, immediateOutput = false)
   success = false
 
   loop do
-    success, consoleOutput = ProcessHelper.run(cmd, immediateOutput)
+    FileUtils.rm_rf @options.qacdata if adminStepAndImmediateOutput
+    success, consoleOutput = ProcessHelper.run(cmd, adminStepAndImmediateOutput)
     licenseError = false
 
     consoleOutput.each_line do |line|
@@ -114,7 +115,6 @@ end
 
     puts "bakeqac: creating database..."
 
-    FileUtils.rm_rf @options.qacdata
     success, consoleOutput, checkError = executeQacli(cmd, true)
 
     if success

data/documentation/_build/html/_sources/changelog.txt

@@ -1,7 +1,15 @@
 Changelog
 =========
 
-January x, 2017 - bake-toolkit 2.27.0
+January 3, 2017 - bake-toolkit 2.28.0
+    * Added: private flag for configs (cannot be referenced directly from outside of the project).
+    * Added: attribute "echo: off" for CommandLine and Makefile.
+    * Added: "--file-list" shows all files and headers of the projects.
+    * Removed: lint support.
+    * Bugfix: environment variables (specified with "Set") can now be set individually for different configs.
+    * Changed: qac: again slightly modified cip workaround.
+
+January 2, 2017 - bake-toolkit 2.27.0
     * Added: local *Adapt* with conditions (e.g. toolchain), see :ref:`adapt_reference`.
     * Changed: qac: cip workaround slightly adapted, removed temporary debug output.
 

data/documentation/_build/html/_sources/concepts/prebuild.txt

@@ -43,7 +43,7 @@ This prebuild behaviour must be explicitly turned on by using the following the
 
     --prebuild
 
-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.
+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.
 
 Typical workflow
 ----------------

data/documentation/_build/html/_sources/index.txt

@@ -1,4 +1,4 @@
-bake 2.27.0
+bake 2.28.0
 ==========================================
 bake, building software **fast** and **easy**!
 

data/documentation/_build/html/_sources/known_issues.txt

@@ -5,5 +5,3 @@ Known Issues
     * Workaround 1: Clean the project.
     * Workaround 2: Delete the archive/executable manually.
     * Workaround 3: Touch, edit, create another source file.
-
-* Issue: Lint output not shown during linting (has to be refactored)

data/documentation/_build/html/_sources/tips_and_tricks/static_code_analysis.txt

@@ -1,122 +1,122 @@
-Static Code Analysis
-====================
-
-Static code analysis often is part or a pre step of the build, even though bake provides presteps which can be used to
-add customized steps, we choose to add explicit support for static code analysis due to the fact that the analysis often
-depends on information well known by the build system (include pahts, compiler flags, etc.). Currently bake has  built in
-support for *Pc-Lint*.
-
-Lint
-****
-
-With bake you can lint LibraryConfigs, ExecutableConfigs, single files and the complete workspace (in this case the projects are linted separately).
-The CPP Toolchain settings of the project are used regardless of the file type and file specific options.
-It is possible to specify lnt-files with LintPolicy, but you can add every other lint command line option as well.
-
-Basic Setup
------------
-
-#. Install `lint  <http://www.gimpel.com/html/products.htm>`_.
-#. Make sure the The lint executable 'lint-nt.exe' is in the path.
-
-.. attention::
-
-    even though there is a unix version of pc-lint the asscoated binary name must be lint-nt.exe otherwise
-    it won't be recorgnized by the bake build system.
-
-After doing this steps you are able to lint your build configurations (LibraryConfigs and ExecutableConfigs) using the *--lint* flag on the command line.
-
-Example
-+++++++
-.. code-block:: console
-
-    User@Host:~$ bake Debug -p MyLibraryProject --lint
-
-
-Configuring Lint
-----------------
-
-In order to configure lint in the Project.meta file, just use the *LintPolicy* command, which forwards the supplied
-the parameters to lint.
-
-.. code-block:: text
-
-    DefaultToolchain GCC {
-        ...
-        LintPolicy "$(ProjectDir)/lint/misra.lnt"
-        LintPolicy "$(ProjectDir)/lint/suppressions.lnt"
-    }
-
-Example
-+++++++
-
-This example shows how to redirect the output to single xml files placed into the main project folder.
-
-.. code-block:: text
-
-    DefaultToolchain GCC {
-        LintPolicy "-os($(MainProjectDir)/$(ProjectName)_$(ConfigName)_lintout.xml)"
-        LintPolicy "-v"
-        LintPolicy "+xml(doc)"
-        LintPolicy "-format=%f %l %t %n %m"
-        LintPolicy "-format_specific= "
-        LintPolicy "-pragma(message)"
-        ...
-    }
-
-
-Known Issues
-------------
-bake only searches for lint-nt.exe
-+++++++++++++++++++++++++++++++++++
-    **Issue:**
-    bake currently does not search for all possible names of the lint application, it only searches for a file called *lint-nt.exe*.
-
-    **Solution:**
-    If you have another lint command (e.g. because you are using flexe lint on unix)
-    just create an symlink/alias which is called *lint-nt.exe*.
-
-Lint fails due to missing compiler includes and defines
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++
-    **Issue:**
-    Lint will fail if compiler internal includes and defines are missing.
-
-    **Solution:**
-
-    Lint comes with some helper files, handle this issue. In order to get a list of all needed
-    helper files e.g. for GCC, use the following command.
-
-    .. code-block:: console
-
-        User@Host:~$ make -f .../PcLint/../lnt/co-gcc.mak
-
-    You will get a output like this:
-
-    .. code-block:: text
-
-        gcc-include-path.lnt, lint_cmac.h, lint_cppmac.h and size-options.lnt.
-
-    You can now add the needed includes and LintPolicies (.lnt files) to your bake
-    configuration.
-
-Lint error due to too many includes
-+++++++++++++++++++++++++++++++++++
-
-    **Issue:**
-    In rare cases lint has problems if it has to open too many (include) files.
-
-    **Solution:**
-    You can use the *--lint-max* and the *--lint-min* options to get around this issue.
-
-    Example:
-
-    .. code-block:: console
-
-        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-max 50                 #(lints the first 51 files)
-        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-min 51 --lint-max 100  #(lints the next 50 files)
-        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-min 101                #(lints the rest of the files)
-
-
-.. Clang Analyze
-.. *************
-
+Static Code Analysis
+====================
+
+Static code analysis often is part or a pre step of the build, even though bake provides presteps which can be used to
+add customized steps, we choose to add explicit support for static code analysis due to the fact that the analysis often
+depends on information well known by the build system (include pahts, compiler flags, etc.). Currently bake has  built in
+support for *Pc-Lint*.
+
+Lint
+****
+
+With bake you can lint LibraryConfigs, ExecutableConfigs, single files and the complete workspace (in this case the projects are linted separately).
+The CPP Toolchain settings of the project are used regardless of the file type and file specific options.
+It is possible to specify lnt-files with LintPolicy, but you can add every other lint command line option as well.
+
+Basic Setup
+-----------
+
+#. Install `lint  <http://www.gimpel.com/html/products.htm>`_.
+#. Make sure the The lint executable 'lint-nt.exe' is in the path.
+
+.. attention::
+
+    even though there is a unix version of pc-lint the asscoated binary name must be lint-nt.exe otherwise
+    it won't be recorgnized by the bake build system.
+
+After doing this steps you are able to lint your build configurations (LibraryConfigs and ExecutableConfigs) using the *--lint* flag on the command line.
+
+Example
++++++++
+.. code-block:: console
+
+    User@Host:~$ bake Debug -p MyLibraryProject --lint
+
+
+Configuring Lint
+----------------
+
+In order to configure lint in the Project.meta file, just use the *LintPolicy* command, which forwards the supplied
+the parameters to lint.
+
+.. code-block:: text
+
+    DefaultToolchain GCC {
+        ...
+        LintPolicy "$(ProjectDir)/lint/misra.lnt"
+        LintPolicy "$(ProjectDir)/lint/suppressions.lnt"
+    }
+
+Example
++++++++
+
+This example shows how to redirect the output to single xml files placed into the main project folder.
+
+.. code-block:: text
+
+    DefaultToolchain GCC {
+        LintPolicy "-os($(MainProjectDir)/$(ProjectName)_$(ConfigName)_lintout.xml)"
+        LintPolicy "-v"
+        LintPolicy "+xml(doc)"
+        LintPolicy "-format=%f %l %t %n %m"
+        LintPolicy "-format_specific= "
+        LintPolicy "-pragma(message)"
+        ...
+    }
+
+
+Known Issues
+------------
+bake only searches for lint-nt.exe
++++++++++++++++++++++++++++++++++++
+    **Issue:**
+    bake currently does not search for all possible names of the lint application, it only searches for a file called *lint-nt.exe*.
+
+    **Solution:**
+    If you have another lint command (e.g. because you are using flexe lint on unix)
+    just create an symlink/alias which is called *lint-nt.exe*.
+
+Lint fails due to missing compiler includes and defines
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+    **Issue:**
+    Lint will fail if compiler internal includes and defines are missing.
+
+    **Solution:**
+
+    Lint comes with some helper files, handle this issue. In order to get a list of all needed
+    helper files e.g. for GCC, use the following command.
+
+    .. code-block:: console
+
+        User@Host:~$ make -f .../PcLint/../lnt/co-gcc.mak
+
+    You will get a output like this:
+
+    .. code-block:: text
+
+        gcc-include-path.lnt, lint_cmac.h, lint_cppmac.h and size-options.lnt.
+
+    You can now add the needed includes and LintPolicies (.lnt files) to your bake
+    configuration.
+
+Lint error due to too many includes
++++++++++++++++++++++++++++++++++++
+
+    **Issue:**
+    In rare cases lint has problems if it has to open too many (include) files.
+
+    **Solution:**
+    You can use the *--lint-max* and the *--lint-min* options to get around this issue.
+
+    Example:
+
+    .. code-block:: console
+
+        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-max 50                 #(lints the first 51 files)
+        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-min 51 --lint-max 100  #(lints the next 50 files)
+        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-min 101                #(lints the rest of the files)
+
+
+.. Clang Analyze
+.. *************
+

data/documentation/_build/html/_sources/tips_and_tricks/tips_and_tricks.txt

@@ -5,7 +5,6 @@ Additional features
     :maxdepth: 1
 
     the_bakery
-    static_code_analysis
     how_to_use_bake_with_cygwin
     the_clang
     dot

data/documentation/_build/html/_static/syntax.html

@@ -65,7 +65,9 @@ z-index: 100;
 &nbsp; <span class="mycomment"># 0..n configs</span><br>
 &nbsp; <span class="showRadio" onMouseover="showExecutableConfig()" onMouseout="notip()" id="executableConfig">ExecutableConfig</span> |
               <span class="hideRadio" onMouseover="showLibraryConfig()" onMouseout="notip()" id="libraryConfig">LibraryConfig</span> |
-              <span class="hideRadio" onMouseover="showCustomConfig()" onMouseout="notip()" id="customConfig">CustomConfig</span> &#60;name&#62;, <span class="help" onMouseover="showExtends()" onMouseout="notip()">extends</span>: &#60;parent(s)&#62; {<br><br>
+              <span class="hideRadio" onMouseover="showCustomConfig()" onMouseout="notip()" id="customConfig">CustomConfig</span> &#60;name&#62;,
+              <span class="help" onMouseover="showExtends()" onMouseout="notip()">extends</span>: &#60;parent(s)&#62;,
+              <span class="help" onMouseover="showPrivate()" onMouseout="notip()">private</span>: true|false {<br><br>
 
 			  <span><span style="background-color:#EEEEEE;" class="show">
 &nbsp; &nbsp; <span class="mycomment"># Valid for all config types</span><br><br>
@@ -85,12 +87,14 @@ z-index: 100;
 										  <span class="help" onMouseover="showMakefilePathTo()" onMouseout="notip()">pathTo</span>: &#60;paths&#62;,
 										  <span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
 										  <span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: &#60;name&#62;,
+										  <span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
 										  <span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: &#60;[array]&#62; {<br>
 &nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showMakefileFlags()" onMouseout="notip()">Flags</span> &#60;flags&#62;<br>
 &nbsp; &nbsp; &nbsp; }<br>
 &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showCommandLine()" onMouseout="notip()">CommandLine</span> &#60;line&#62;,
 										  <span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
 										  <span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: &#60;name&#62;,
+										  <span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
 										  <span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: &#60;[array]&#62;<br>
 &nbsp; &nbsp; }<br>
 &nbsp; &nbsp; <span class="help" onMouseover="showPostSteps()" onMouseout="notip()">PostSteps</span> {<br>
@@ -120,7 +124,6 @@ z-index: 100;
 &nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLibPostfixFlags()" onMouseout="notip()">LibPostfixFlags</span> &#60;flags&#62;<br>
 &nbsp; &nbsp; &nbsp; }<br>
 &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showInternalIncludes()" onMouseout="notip()">InternalIncludes</span> &#60;file&#62;<br>
-&nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showDefaultLintPolicy()" onMouseout="notip()">LintPolicy</span> &#60;policy&#62;<br>
 &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showDocu()" onMouseout="notip()">Docu</span> &#60;cmdLine&#62;<br>
 &nbsp; &nbsp; }<br>
 
@@ -141,7 +144,6 @@ z-index: 100;
 &nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLibPrefixFlags()" onMouseout="notip()">LibPrefixFlags</span> &#60;flags&#62;, add: &#60;flags&#62;, remove: &#60;flags&#62<br>
 &nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLibPostfixFlags()" onMouseout="notip()">LibPostfixFlags</span> &#60;flags&#62;, add: &#60;flags&#62;, remove: &#60;flags&#62<br>
 &nbsp; &nbsp; &nbsp; }<br>
-&nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLintPolicy()" onMouseout="notip()">LintPolicy</span> &#60;policy&#62;<br>
 &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showDocu()" onMouseout="notip()">Docu</span> &#60;cmdLine&#62;<br>
 &nbsp; &nbsp; }<br>
 &nbsp; &nbsp; <span class="help" onMouseover="showPrebuild()" onMouseout="notip()">Prebuild</span> {<br>
@@ -177,6 +179,7 @@ z-index: 100;
 										  <span class="help" onMouseover="showMakefilePathTo()" onMouseout="notip()">pathTo</span>: &#60;paths&#62;,
 										  <span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
                                           <span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: &#60;name&#62;,
+                                          <span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
                                           <span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: &#60;[array]&#62; {<br>
 &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showMakefileFlags()" onMouseout="notip()">Flags</span> &#60;flags&#62;<br>
 &nbsp; &nbsp; }<br>
@@ -184,13 +187,14 @@ z-index: 100;
                             <span style="background-color:#DDDDDD;" id="commandline_part"  class="hide">&#60;line&#62;,
                             <span class="help" onMouseover="showStepDefault()" onMouseout="notip()">default</span>: on|off,
                             <span class="help" onMouseover="showStepFilter()" onMouseout="notip()">filter</span>: &#60;name&#62;,
+                            <span class="help" onMouseover="showEcho()" onMouseout="notip()">echo</span>: on|off,
                             <span class="help" onMouseover="showValidExitCodes()" onMouseout="notip()">validExitCodes</span>: &#60;[array]&#62;
                             </span>
 &nbsp; &nbsp; <br></span><br></span>
 &nbsp; }<br>
 }<br><br>
-Adapt toolchain: &#60;name&#62;, os: &#60;name&#62;, mainProject: &#60;name&#62;, mainConfig: &#60;name&#62;{<br>
-... see adapt documention for details.<br>
+Adapt toolchain: &#60;name&#62;, os: &#60;name&#62;, mainProject: &#60;name&#62;, mainConfig: &#60;name&#62; {<br>
+&nbsp; <span class="mycomment"># See Adapt documention for details.</span><br>
 }<br>
 
 
@@ -345,6 +349,11 @@ function showStepDefault() {
   ddrivetip("default", "No","-","on",str)
 }
 
+function showEcho() {
+  str = 'On means the command line is shown in output, off means the command line is not shown.'
+  ddrivetip("echo", "No","-","on",str)
+}
+
 function showStepFilter() {
   str = 'A step can be switched on or off explicitly regardless of the "default" attribute with the command line options<br>'+
 	'<i> &nbsp; &nbsp; --do &#60;filter name&#62;</i><br>'+
@@ -429,6 +438,10 @@ function showExtends() {
 	ddrivetip("extends", "No","0..1","-","Inherit settings from parent config(s).<br>For more information see docu page 'Derive configs'.")
 }
 
+function showPrivate() {
+    ddrivetip("private", "No","0..1","false","If true, the config cannot be referenced directly outside of this project.")
+}
+
 function showFiles() {
   str = 'Specifies the files to build.<br>'+
     'It\'s valid to specify a single file, e.g.<br>'+
@@ -616,10 +629,6 @@ function showLinker() {
   ddrivetip("Linker", "No","0..1","-","Makes sense only for ExecutableConfigs.")
 }
 
-function showLintPolicy() {
-  ddrivetip("LintPolicy", "No","0..n","-","lnt-file - but it can be used for any other command line option for Lint.")
-}
-
 function showDocu() {
   ddrivetip("Docu", "No","0..1","-","Command to build the documentation. e.g.:<br>doxygen main.cfg")
 }
@@ -652,10 +661,6 @@ function showDefaultLinker() {
   ddrivetip("Linker", "No","0..1","-","Default settings for the linker.")
 }
 
-function showDefaultLintPolicy() {
-  ddrivetip("LintPolicy", "No","0..n","-","lnt-file - but it can be used for any other command line option for Lint.")
-}
-
 function showCommand() {
   ddrivetip("command", "No","-","Depending on toolchain, e.g. \"gcc\"","Change command, e.g. \"$(PATH_TO_EXE)/gcc_speciale.exe\"")
 }

data/documentation/_build/html/changelog.html

@@ -140,7 +140,17 @@
   <div class="section" id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
 <dl class="docutils">
-<dt>January x, 2017 - bake-toolkit 2.27.0</dt>
+<dt>January 3, 2017 - bake-toolkit 2.28.0</dt>
+<dd><ul class="first last simple">
+<li>Added: private flag for configs (cannot be referenced directly from outside of the project).</li>
+<li>Added: attribute &#8220;echo: off&#8221; for CommandLine and Makefile.</li>
+<li>Added: &#8220;&#8211;file-list&#8221; shows all files and headers of the projects.</li>
+<li>Removed: lint support.</li>
+<li>Bugfix: environment variables (specified with &#8220;Set&#8221;) can now be set individually for different configs.</li>
+<li>Changed: qac: again slightly modified cip workaround.</li>
+</ul>
+</dd>
+<dt>January 2, 2017 - bake-toolkit 2.27.0</dt>
 <dd><ul class="first last simple">
 <li>Added: local <em>Adapt</em> with conditions (e.g. toolchain), see <a class="reference internal" href="syntax/adapt_configs.html#adapt-reference"><span>Adapt configs</span></a>.</li>
 <li>Changed: qac: cip workaround slightly adapted, removed temporary debug output.</li>