Generating Reports

The comparerelease command generates both HTML and XML reports. This command is used to compare the data to identify breaks if any. For more information, see Comparing the data and CDB commands.

An xml report is machine readable. A typical XML report generated would look like the following:

Currently, colours can be specified only for access levels and not for status levels when generating the report. After producing the xml report, the comparerelease command creates a new access.xml file containing the access and colour mappings from the plug-in.

An XSL file is used to transform the xml file into a .htm file. It looks for the colour in access.xml when it hits an access element.

A .htm report is used to read and understand the details of the break. The plug-in can specify the colours to be used to display the access levels when producing the HTML report. A typical HTML report is shown below:

The html report provides the following information:

1. timestamp of comparison

2. reference configuration (old release)

3. checked configuration (new release)

4. summary of number of breaks and level of breaks

   You can control the level of breaks that is shown in the report using –f [option] in comparerelease command. For more information on this command, see CDB commands

   Various possible options are shown at the end of the report with different colours specifying their importance. These colours are Classifier plug-in dependent. The following list describes these options:

   • Orange (Not Specified) - the level of break is not specified in comparerelease command and its importantance is very high

   • Red (Published All) - the level of break that affects everyone; it is very important

   • Red (Published Partner) - the level of break that is affecting only our partners and Symbian internal, and its importance is also high

   • All Green - the level of break that affects Symbian internally

   • Grey (Not Applicable) – CDB does not support classification of these breaks

   • Not Defined - a classification level was specified for an entity but the Classifier plug-in does not recognise it.

5. CLASS: CEikCheckBox (….\techview\eikchkbx.h) – gives you the name of the file in which breaks occurred. You can go straight to the file to fix the breaks.

6. If you are expecting a break, the table in the report lists the following details of a break:

   • at what position it is expected (if it expected a break)

   • at what line it is expected

   • what break it has got

   • at what position the break has occured

   • at what line the break has occured

   • access information of the break. For example, publishedAll, publishedPartner, internalComponent and so on.

   • status information of the break. For example, released, deprecated and so on.