bake-toolkit 2.24.6 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f2d7170b26cbdbc70b0088ff731af07ef3f623a
-  data.tar.gz: 30132e42d5dafcbc3dc047eb17021c9184bb9379
+  metadata.gz: 3234ed733373462ddbf0bed1ad2e368f5340f87b
+  data.tar.gz: ae8511630f714943ae55bc9f1f66a89b68fd54cf
 SHA512:
-  metadata.gz: 6ecb9653e3655a6cbc0c454a0263925ea45f1686e81409fc45434445f632c55f5b044fb459463725413355c1dd8d5ca125ac72b01988d49eb125ffa52b1a7b5e
-  data.tar.gz: bdf1bcc8e32078aef69722152c11c37deb459191fa8bee2d9f76551737c65071ba39eeac737f9b9f71f11fbf889e3858ef3068fcbd71856b94d29fbe29b4be68
+  metadata.gz: b1cf9cfbaaed777dcb90cb561bdd6e254ead94f17c9eb63c8632b7aad3839d7e24da9cd7145b8bc8dac4975b5e94d5555cd3e7dfa071bd4a78868719747af231
+  data.tar.gz: fc6ddce74ba7226b927e91c7c804de3bb9f8901517ee04094bc119b77dfcfde104ad3f66a6d73390418b01edecad6dd7b198f39456830165e16285ac8dfc034f

data/bin/bake-doc

@@ -1,11 +1,11 @@
-#!/usr/bin/env ruby
-
-$:.unshift(File.dirname(__FILE__)+"/../lib")
-require 'common/version'
-
-Bake::Version.printBakeVersion
-
-puts "Command \"bake-doc\" not supported anymore. Please use"
-puts "\"bake --doc\" to open the documentation in the browser OR"
-puts "\"bake --generate-doc ...\" for building the documentation of a project."
-exit(1)
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__)+"/../lib")
+require 'common/version'
+
+Bake::Version.printBakeVersion
+
+puts "Command \"bake-doc\" not supported anymore. Please use"
+puts "\"bake --doc\" to open the documentation in the browser OR"
+puts "\"bake --generate-doc ...\" for building the documentation of a project."
+exit(1)

data/bin/bake-format

@@ -21,8 +21,8 @@ begin
   end
 rescue
   puts [
-    "Usage: #{__FILE__} [--ident=string] input output",
-    "  --indent=string, ident defaults to two spaces.",
+    "Usage: #{__FILE__} [--indent=string] input output",
+    "  --indent=string, indent defaults to two spaces.",
     "    Note, you can escape a tab in bash by ctrl-vTAB with sourrounding \" e.g. \"--input=    \"",
     "  input, filename or '-' for stdin",
     "  output, filename, '-' for stdout, '--' for same as input file"

data/bin/bakeclean

@@ -1,32 +1,32 @@
-#!/usr/bin/env ruby
-
-$:.unshift(File.dirname(__FILE__)+"/../lib")
-require "bakeclean/options/options"
-require "fileutils"
-
-$options = Bake::BakecleanOptions.new(ARGV)
-$options.parse_options()
-
-def remove(folder)
-  if File.exist?folder
-    puts folder
-    FileUtils.rm_rf(folder) unless $options.preview
-  end
-end
-
-puts $options.preview ? "*** Preview ***" : "***  Deleting ***"
-
-bakes = Dir.glob("**/.bake")
-bakes.each do |b|
-  remove(b)
-  projectDir = File.dirname(b)
-  remove(projectDir+"/build")
-
-  builds = Dir.glob(projectDir + "/build_*")
-  builds.each do |build|
-    remove(build)
-  end
-
-end
-
-exit(0)
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__)+"/../lib")
+require "bakeclean/options/options"
+require "fileutils"
+
+$options = Bake::BakecleanOptions.new(ARGV)
+$options.parse_options()
+
+def remove(folder)
+  if File.exist?folder
+    puts folder
+    FileUtils.rm_rf(folder) unless $options.preview
+  end
+end
+
+puts $options.preview ? "*** Preview ***" : "***  Deleting ***"
+
+bakes = Dir.glob("**/.bake")
+bakes.each do |b|
+  remove(b)
+  projectDir = File.dirname(b)
+  remove(projectDir+"/build")
+
+  builds = Dir.glob(projectDir + "/build_*")
+  builds.each do |build|
+    remove(build)
+  end
+
+end
+
+exit(0)

data/bin/bakeqac

@@ -15,6 +15,15 @@ STDERR.sync = true
 
 module Bake
 
+def self.printCip()
+  cips = Dir.glob(@options.qacdata + "/**/*.cip")
+  if !cips.empty?
+    puts "Temporary debug output to find a highly sporadic bug regarding cip file, sorry for spam:"
+    puts "cip file name: #{cips[0]}"
+    puts "cip file size: #{File.size?(cips[0])}"
+  end
+end
+
 ###### PREREQUISITE 1: BAKEQAC OPTIONS ######
 
   @options = BakeqacOptions.new(ARGV)
@@ -73,14 +82,11 @@ end
       FileUtils.rm_rf @options.qacdata
       success, consoleOutput = ProcessHelper.run(cmd, true)
 
-      puts "Temporary debug output:"
-
       break if not success
-      cips = Dir.glob(@options.qacdata + "/**/*.cip")
 
-      p cips
-      puts (!cips.empty?)
-      puts (!File.size?(cips[0]).nil?)
+      printCip()
+
+      cips = Dir.glob(@options.qacdata + "/**/*.cip")
       break if (!cips.empty?) && (!File.size?(cips[0]).nil?) # this is the regular case, note: "size?" returns nil if empty or not existing
 
       cipCounter += 1
@@ -186,6 +192,7 @@ end
       puts consoleOutput # no filter
     end
 
+    printCip()
   end
 
 
@@ -305,8 +312,72 @@ end
       puts consoleOutput # no filter
     end
 
+    printCip()
+
   end
 
+###### STEP 4a: REPORT SCRIPT CHECK (OPTIONAL) ######
+
+  if success and !@options.qacstep.nil? and @options.qacstep.include?("report")
+
+    puts "bakeqac: preparing reports..."
+
+    # check if adapted
+    scriptsAdapted = true
+    [@options.qac_home+"/report_plugins/Rule_Compliance_Report.py", @options.qac_home+"/report_plugins/Suppressions_Report.py"].each do |script|
+      if !File.exist?script
+        puts "Error: script #{script} not found"
+        success = false
+        break
+      end
+
+      foundVersion = false
+      File.open(script, "r").each_line do |line|
+        scan_res = line.scan(/v(\d+\.\d+): Adapted.+_Report\.py/)
+        if scan_res.length > 0
+          puts "Info: script #{script} has version \"#{scan_res[0][0]}\""
+          foundVersion = true
+          break
+        end
+      end
+      puts "Info: script #{script} not adapted" if foundVersion == false
+
+    end
+
+  end
+
+###### STEP 4b: REPORT SUR (OPTIONAL) ######
+
+  if success and !@options.qacstep.nil? and @options.qacstep.include?("report")
+    FileUtils::mkdir_p @options.qacdata
+
+    puts "bakeqac: generating SUR report..."
+
+    cmd = qaExe + ["report", "-P", @options.qacdata, "-t", "SUR"]
+
+    success, consoleOutput = ProcessHelper.run(cmd, false)
+    puts consoleOutput
+
+  end
+
+###### STEP 4c: REPORT RCR (OPTIONAL) ######
+
+  if success and !@options.qacstep.nil? and @options.qacstep.include?("report")
+    FileUtils::mkdir_p @options.qacdata
+
+    puts "bakeqac: generating RCR report..."
+
+    cmd = qaExe + ["report", "-P", @options.qacdata, "-t", "RCR"]
+
+    success, consoleOutput = ProcessHelper.run(cmd, false)
+    puts consoleOutput
+
+  end
+
+
+#### TODO: unittest for report
+
+
 ###### DONE ######
 
   exit(success ? 0 : 1)

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

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+December 15, 2016 - bake-toolkit 2.25.0
+    * Changed (!): before this version, all "IncludeDir"s were evaluated prior to the "Dependency"s to calculate the include path string for the compiler. Now the line order
+      is taken into account. To get the same include path string as in 2.24.x, shift all "IncludeDir"s in front of the first "Dependency".
+    * Added: it is possible to mark an IncludeDir with "system: true", which means that e.g. for gcc "-isystem" is used instead of "-I". Very useful for third party libs.
+    * Bugfix: qac: adapted parser to new gcc version strings. On some machines an incorrect CCT was chosen.
+    * Bugfix: when building with "-p <projectname>", bake has not only built <projectname>, but also all injected dependencies of <projectname>, which was not intended.
+    * Added: qac: additional step to generate reports, activate it manually with "--qacstep report", see documentation.
+    * Cosmetic: Adapt.meta files are also cached now.
+    * Temporary: cip bug workaround from 2.24.2 does not work, added some debug output to get more infos - sorry for the spam - will be removed soon.
+
 December 5, 2016 - bake-toolkit 2.24.3
     * Added: qac: if "<mainConfigName>Qac" is found in main project, it will be used instead of "<mainConfigName>"
     * Added: First version of bake-format script, thanks to gizmomogwai

data/documentation/_build/html/_sources/ide/ide_integrations.txt

@@ -1,8 +1,40 @@
-IDE Support
-===========
-
-.. toctree::
-    :maxdepth: 2
-
-    eclipse/eclipse
-    vs/vs
+IDE Support
+===========
+
+.. toctree::
+    :maxdepth: 1
+
+    eclipse/eclipse
+    vs/vs
+
+The integrations for eclipse and visual studio are the ones that are
+most used and best documented.
+
+.. image:: ../_static/eclipse.png
+   :target: eclipse/eclipse.html
+
+.. image:: ../_static/visualstudio-pro.png
+   :target: vs/vs.html
+
+
+Basic integrations
+******************
+
+The following integrations lack in features, documentation and
+maturity compared to the above integrations. Still they provide you
+with a starting point.
+
+.. image:: ../_static/emacs.png
+   :target: http://github.com/gizmomogwai/bake-mode
+
+.. image:: ../_static/notepad.png
+   :target: https://github.com/sanastasiou/RTextNpp/releases
+
+.. image:: ../_static/vim.png
+   :target: https://github.com/flxo/bake.vim
+
+The beautiful IDE icons are designed by `Kat On`_ and used under the
+`creative commons license v3.0`_.
+
+.. _Kat On: https://www.squirrelmuffins.com
+.. _creative commons license v3.0: https://creativecommons.org/licenses/by/3.0

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

@@ -1,4 +1,4 @@
-bake 2.24.3
+bake 2.25.0
 ==========================================
 bake, building software **fast** and **easy**!
 

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

@@ -1,153 +1,160 @@
-QACPP
-*****
-
-bakeqac is a convenience wrapper for QACPP with some nice features.
-
-Without bakeqac
----------------
-
-QACPP can be called directly from command line:
-
-.. code-block:: console
-
-    qacli admin --qaf-project-config --qaf-project qacdata --cct <cct> --rcf <rcf> --acf <acf>
-    qacli analyze -P qacdata -b <bake call>
-    qacli view -P qacdata -m STDOUT
-
-- The first command creates the qac project database.
-- The second command builds and analyzes the files.
-- The third command prints out the result unfiltered.
-
-With bakeqac
-------------
-
-Instead of writing
-
-.. code-block:: console
-
-    bake <options>
-
-for regular build, simply write:
-
-.. code-block:: console
-
-    bakeqac <options>
-
-bakeqac will automatically do the three steps mentioned above. If one of these steps fails, the consecutive steps will be dismissed.
-
-You can also choose certain steps (can be combined with "|"):
-
-.. code-block:: console
-
-    bakeqac <options> --qacstep admin|analyze|view
-    bakeqac <options> --qacstep admin
-    etc.
-
-Step 1: admin
--------------
-
-You have to set the environment variable QAC_HOME, e.g. to *c:\\tools\\prqa\\PRQA-Framework-2.1.0*. If not specified otherwise, cct, rcf and acf will be automatically chosen.
-
-- Configuration compiler template (cct): Only GCC is supported. bakeqac tries to get the platform and the GCC version and calculates the path to the right cct file. To overwrite this behaviour, specify one or more ccts:
-
-  .. code-block:: console
-
-      bakeqac <options> --cct <first> --cct <second>
-
-  Alternatively, you can add
-
-  .. code-block:: console
-
-      bakeqac <options> --c++11
-      bakeqac <options> --c++14
-
-  to enforce bakeqac choosing the C++11 or C++14 toolchain.
-
-  If --cct is not used, bakeqac uses a built-in cct file as mentioned above. Additionally, it searched for a file named qac.cct up to root and appends the content to the original cct file.
-  This may be used to add additional configuration parameters which are compiler independent, e.q. "-n 1234" suppresses warning 1234.
-
-- Rule configuration file (rcf): Can be specified with:
-
-  .. code-block:: console
-
-      bakeqac <options> --rcf <rcf>
-
-  If not specified, bakeqac uses $(QAC_HOME)/config/rcf/mcpp-1_5_1-en_US.rcf.
-
-- Analysis configuration file (acf): Can be specified with:
-
-  .. code-block:: console
-
-      bakeqac <options> --acf <acf>
-
-  If not specified, $(QAC_HOME)/config/acf/default.acf will be used.
-
-- You can also specify the qacdata folder, default is *.qacdata*:
-
-  .. code-block:: console
-
-      bakeqac <options> --qacdata anotherFolder
-
-
-Step 2: analyze
----------------
-
-This is the main step. Use exactly the same options for bakeqac as for bake. A few things have to be mentioned:
-
-- *--compile-only* will be automatically added
-- *--rebuild* will be automatically added
-
-The output will be filtered per default (e.g. some warnings) . To get unfiltered output, write:
-
-.. code-block:: console
-
-    bakeqac <options> --qacnofilter
-
-Step 3: view
-------------
-
-Results are also filtered in this step if not specified otherwise:
-
-- Only results from compiled bake projects will be shown (which does not apply to e.g. compiler libraries). To narrow the results, use the *-p* option.
-- Files from subfolders test and mock will be filtered out.
-- Files from projects gtest and gmock will be filtered out.
-
-bakeqac slightly reformats the output (originally the violated MISRA rule numbers are printed out incomplete). To switch back to raw format, use:
-
-.. code-block:: console
-
-    bakeqac <options> --qacrawformat
-
-To get additional links to the appropriate documentation pages use:
-
-.. code-block:: console
-
-    bakeqac <options> --qacdoc
-
-Colored output is also supported similar to bake:
-
-.. code-block:: console
-
-    bakeqac <options> -a <color_scheme>
-
-
-Additional options
-------------------
-
-QACPP needs a license. If floating licenses are not available, bakeqac can retry to checkout them:
-
-.. code-block:: console
-
-    bakeqac <options> --qacretry <seconds>
-
-Step 2 and 3 are retried until timeout is reached.
-
-Notes
------
-
-If "<mainConfigName>Qac" is found in main project, it will be used instead of "<mainConfigName>. This is useful if the unit test has to be built different to MISRA.
-
-Example output
---------------
-
+QACPP
+*****
+
+bakeqac is a convenience wrapper for QACPP with some nice features.
+
+Without bakeqac
+---------------
+
+QACPP can be called directly from command line:
+
+.. code-block:: console
+
+    qacli admin --qaf-project-config --qaf-project qacdata --cct <cct> --rcf <rcf> --acf <acf>
+    qacli analyze -P qacdata -b <bake call>
+    qacli view -P qacdata -m STDOUT
+    qacli report -P qacdata -t SUR # or -t RCR. Please also note, that the "view" is not necessary to generate the reports.
+
+- The first command creates the qac project database.
+- The second command builds and analyzes the files.
+- The third command prints out the result unfiltered.
+- The forth command generates reports. You may replace the python scripts in PRQA to adapt the output.
+
+With bakeqac
+------------
+
+Instead of writing
+
+.. code-block:: console
+
+    bake <options>
+
+for regular build, simply write:
+
+.. code-block:: console
+
+    bakeqac <options>
+
+bakeqac will automatically do the first three steps mentioned above. If one of these steps fails, the consecutive steps will be dismissed.
+
+You can also choose certain steps (can be combined with "|"):
+
+.. code-block:: console
+
+    bakeqac <options> --qacstep admin|analyze|view|report
+    bakeqac <options> --qacstep admin
+    etc.
+
+Step 1: admin
+-------------
+
+You have to set the environment variable QAC_HOME, e.g. to *c:\\tools\\prqa\\PRQA-Framework-2.1.0*. If not specified otherwise, cct, rcf and acf will be automatically chosen.
+
+- Configuration compiler template (cct): Only GCC is supported. bakeqac tries to get the platform and the GCC version and calculates the path to the right cct file. To overwrite this behaviour, specify one or more ccts:
+
+  .. code-block:: console
+
+      bakeqac <options> --cct <first> --cct <second>
+
+  Alternatively, you can add
+
+  .. code-block:: console
+
+      bakeqac <options> --c++11
+      bakeqac <options> --c++14
+
+  to enforce bakeqac choosing the C++11 or C++14 toolchain.
+
+  If --cct is not used, bakeqac uses a built-in cct file as mentioned above. Additionally, it searched for a file named qac.cct up to root and appends the content to the original cct file.
+  This may be used to add additional configuration parameters which are compiler independent, e.q. "-n 1234" suppresses warning 1234.
+
+- Rule configuration file (rcf): Can be specified with:
+
+  .. code-block:: console
+
+      bakeqac <options> --rcf <rcf>
+
+  If not specified, bakeqac uses $(QAC_HOME)/config/rcf/mcpp-1_5_1-en_US.rcf.
+
+- Analysis configuration file (acf): Can be specified with:
+
+  .. code-block:: console
+
+      bakeqac <options> --acf <acf>
+
+  If not specified, $(QAC_HOME)/config/acf/default.acf will be used.
+
+- You can also specify the qacdata folder, default is *.qacdata*:
+
+  .. code-block:: console
+
+      bakeqac <options> --qacdata anotherFolder
+
+
+Step 2: analyze
+---------------
+
+This is the main step. Use exactly the same options for bakeqac as for bake. A few things have to be mentioned:
+
+- *--compile-only* will be automatically added
+- *--rebuild* will be automatically added
+
+The output will be filtered per default (e.g. some warnings) . To get unfiltered output, write:
+
+.. code-block:: console
+
+    bakeqac <options> --qacnofilter
+
+Step 3: view
+------------
+
+Results are also filtered in this step if not specified otherwise:
+
+- Only results from compiled bake projects will be shown (which does not apply to e.g. compiler libraries). To narrow the results, use the *-p* option.
+- Files from subfolders test and mock will be filtered out.
+- Files from projects gtest and gmock will be filtered out.
+
+bakeqac slightly reformats the output (originally the violated MISRA rule numbers are printed out incomplete). To switch back to raw format, use:
+
+.. code-block:: console
+
+    bakeqac <options> --qacrawformat
+
+To get additional links to the appropriate documentation pages use:
+
+.. code-block:: console
+
+    bakeqac <options> --qacdoc
+
+Colored output is also supported similar to bake:
+
+.. code-block:: console
+
+    bakeqac <options> -a <color_scheme>
+
+Step 4: report
+--------------
+
+Reports about the warnings and suppressed warnings are be generated.
+
+
+Additional options
+------------------
+
+QACPP needs a license. If floating licenses are not available, bakeqac can retry to checkout them:
+
+.. code-block:: console
+
+    bakeqac <options> --qacretry <seconds>
+
+Steps "analyze" and "view" are retried until timeout is reached.
+
+Notes
+-----
+
+If "<mainConfigName>Qac" is found in main project, it will be used instead of "<mainConfigName>. This is useful if the unit test has to be built different to MISRA.
+
+Example output
+--------------
+
 .. image:: ../_static/misra.png