Changes between Version 14 and Version 15 of GSoC/2017/coveragetools

Timestamp:

07/28/17 13:37:08 (7 years ago)

Author:

Cillian O'Donnell

Comment:

Improve Documentation

GSoC/2017/coveragetools

@@ -57 +57 @@
 = Coverage Analysis in RTEMS Tester =
 == Symbol Set Configurtion ==
-The tests run in rtems-test will be used to check what percentage of the symbols they cover and the symbols to be analysed are in the symbol set config file which can be found here
+The tests run in rtems-test will have there trace data logged in a file called <test_name>.exe.cov. This will be used to check what percentage of the symbols they cover and the symbols to be analysed are in the symbol set config file which can be found here
 {{{
 From top directory of rtems-tools
@@ -69 +69 @@
 The format of the config file is
 
+{{{
  symbolset:
  name = NAME_OF_SET
@@ -80 +81 @@
  name = NAME_OF_ANOTHER_SET
  lib = ... 
+}}}
 
 1. Each set is defined with the keyword 'symbolset:' 
@@ -94 +96 @@
 
 == Supported BSPS ==
-Leon 3: Use 'rtems-bsp=leon3-qemu' with rtems-test cmd.
+Leon 3: Use '--rtems-bsp=leon3-qemu' with rtems-test cmd.
 
 == Performing Coverage Analysis with rtems-test command ==
@@ -120 +122 @@
 }}}
 
-After the testsuite is run, covoar then performs multiple runs for all tests on each symbol set in symbol_set.cfg. Covoar sections the objdump into seperate functions and uses the trace data from Couverture-Qemu that records trace blocks as 'executed' and 'not executed' to mark branches as 'taken' and 'not taken'. Covoar then creates coverage maps from the results. The maps are then merged together and a report is generated. The report is a html file that can be found in the directory created above coverage_test called report.html.
+After the testsuite is run, covoar then performs multiple runs analysing the trace data collected by Couverture-QEMU for all tests on each symbol set in symbol_set.cfg. Covoar sections the objdump into seperate functions and uses the trace data from Couverture-Qemu that records trace blocks as 'executed' and 'not executed' to mark branches as 'taken' and 'not taken'. Covoar then creates coverage maps from the results. The maps are then merged together and a report is generated. The report is a html file that can be found in the directory created above coverage_test called report.html.
 
 {{{