Klocwork documentation

Learning

Klocwork University
View detailed technical videos on Klocwork tools on the Klocwork Universtity page.

Tips for Insight 9.5 / 9.6 users

Klocwork Management Console (KMC) to Klocwork Review and the removal of build capability

All KMC administration capability has now been moved to Klocwork Review in Insight 9.5 and newer.  This means that you can edit roles and access, create, delete and rename projects or builds, and you can add or remove configuration files. 

One removed capability that existed in Insight 9.2 and earlier is that if you had a build specification file, you could tell the KMC to run a build.  This capability no longer exists. We encourage you to use the command line build utilities (kwinject, kwant, kwbuildproject, kwadmin) to build your projects.  This is the best solution for scalability and automating your builds with Klocwork Insight.

Another change is Java project builds. In Insight 9.2 and earlier, you were allowed to build a Java project from sources. In Insight 9.5, use kwant to generate your build specification and never build from sources. Building from java sources can be inaccurate as it does not reflect the actual build process. If for some reason you have only been using the build from sources option in KMC, contact Klocwork Support so we can work out a solution for you.

Build integration practices

Klocwork Insight 9.5 introduces a new build option called “--replace-path”.  Use this with kwbuildproject:

kwbuildproject --replace-path /vob/foo/bar/blah/source/projectX/src=src <other options>

Why is this useful?  Think about clicks. If you want to drill down into a report, you are drilling into the entire prefix of your build. This is completely eliminated, and now you minimize the number of clicks the next time you drill into your component diagram.  This path replacement gets applied across all of Klocwork’s tools -  whether you’re using Klocwork Architect, creating modules, exporting the defect information, or just looking at all the issues in Klocwork Review. Those unnecessary paths are truncated, making using any Klocwork tool that much easier.

Views and modules vs. scopes

In previous releases of Insight, we had the concept of scopes.  This allowed you to filter out any aspect of the analysis to focus on what matters.  For example, if you only wanted to see a report with severity 1-3 you would create a scope.  In Insight 9.5, scopes have been removed in favour of a new concept called “views” and “modules”.  Views are essentially the same thing, however they use the Klocwork search syntax you have grown to love with the issue list.  Modules are the same thing except they are only for defining - you guessed it - modules.  A view would specify a module as part of the search string.  What are the advantages of views and modules over scopes? 

  • Easy to use search syntax
  • They work across reports and issues automatically
  • You can define them as the default view
  • You can use the Web API to create them before the project is even built

Deprecated messages (kwinspectreport XML and Review XML output)

Starting in Insight 9.5 kwinspectreport XML output and Review XML export is deprecated.  This means they are still available in Insight 9.5, but will be removed in the release after 9.5. The reason for this is the great output we now have with the Web API. Use the Web API to generate any data you need from the defects for further post processing. The Web API is here to stay and provides a richer interface to customize and work in your environment. For those using XML export, the Web API will not contain citing history, traceback, line number and comment information.