ECLAIR can produce different kinds of reports in different formats. In this page you have a sample of the various report kinds in some of the supported formats for the analysis of a real-life embedded software project.
The analyzed project, which is meant to comply to MISRA C:2004 (with justified deviations), is copyrighted by Quantum Leaps, LLC, and is open source software: it can be redistributed and/or modified under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or any later version. In this analysis, the justified deviations reported in the Application Note shipped along with the project sources have been captured in the ECLAIR configuration.
For copyright reasons (all MISRA text is copyrighted by The MISRA Consortium Limited) the headlines of the MISRA C:2004 rules have been substituted with rough description of what ECLAIR is reporting. ECLAIR supports all versions of MISRA C and MISRA C++ as well as other coding standards.
Interactive detailed reports
These reports contain full details about each reported program condition (such as a coding rule violation or a possible run-time error). Here, full details means that all the information required for a proper understanding of the issue is presented, e.g.:
the exact position in the source code;
in case macros are involved, the source code both before and after preprocessing, and the definitions of the macros involved;
a path in the program leading to the reported run-time error.
Interactive detailed reports can be viewed by all licensed users by means of the ECLAIR browser. Users with a site, multisite or enterprise license can also generate standalone HTML output. From the point of view of the user experience, these two possibilities are completely equivalent.
Interactive reports are largely self-explicative (of course they are fully documented in the ECLAIR manual). For now, we suggest you proceed by experiments: pay attention to hover effects and click on the various areas to see what happens. In addition, below are some suggestions you may want to try.
Here you will see the MISRA C:2004 guidelines violated by the project.
This will make the rules' summaries appear/disappear.
See an example of how ECLAIR allows you to explore violations when macros are involved.
Please note that its first area (the first line in blue, showing the location of a non-compliant if-then-else guard) has two sub-areas (the next two lines in blue):
the first sub-area shows the same region of code of the main area, but after preprocessing;
the second sub-area shows the region of code where the "guilty" macro is defined.
Summary reports in printable format
These reports contain a summary of ECLAIR findings that is suitable for the communication to third parties in order, e.g., to substantiate a claim of MISRA compliance. All sections of such reports are optional: below you can obtain an example including just everything (as it would be appropriate for the final analysis of a safety-critical project).
Summary reports in spreadsheet format
Summary reports in spreadsheet format
These interactive summary reports contain a summary of ECLAIR findings that is suitable for the communication to third parties that are only interested in the residual violations and whether they have been justified and how. These reports are interactive in the sense that the level of detail provided can be dynamically controlled. The supplied compressed archive contains instructions on how to use these reports with Microsoft Excel, LibreOffice Calc or OpenOffice.org Calc.
Summary reports in pure text format
These reports contain various summaries of ECLAIR findings. Just unpack the supplied compressed archive and see the files contained therein.
Metrics
These reports contain the values of the metrics collected for each file, function and project. The supplied compressed archive contains instructions on how to use these reports with Microsoft Excel, LibreOffice Calc or OpenOffice.org Calc.