Home | History | Annotate | Download | only in doc
      1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
      2 <style type="text/css">p, table, td, th {  font-family: arial, helvetica, geneva; font-size: 10pt}
      3 pre {  font-family: "Courier New", Courier, mono; font-size: 10pt}
      4 h2 { font-family: arial, helvetica, geneva; font-size: 18pt; font-weight: bold ; line-height: 14px}
      5 code {  font-family: "Courier New", Courier, mono; font-size: 10pt}
      6 sup {  font-family: arial,helvetica,geneva; font-size: 10px}
      7 h3 {  font-family: arial, helvetica, geneva; font-size: 14pt; font-weight: bold}
      8 li {  font-family: arial, helvetica, geneva; font-size: 10pt}
      9 h1 {  font-family: arial, helvetica, geneva; font-size: 28px; font-weight: bold}
     10 body {  font-family: arial, helvetica, geneva; font-size: 10pt; clip:   rect(   ); margin-top: 5mm; margin-left: 3mm}
     11 .indextop { font-size: x-large;; font-family: Verdana, Arial, Helvetica, sans-serif; font-weight: bold}
     12 .indexsub { font-size: xx-small;; font-family: Arial, Helvetica, sans-serif; color: #8080FF}
     13 </style>
     14 <body>
     15 <p>
     16 <h1>Table of contents</h1>
     17 <ul>
     18 <li><a href="#scales">Scales</a>
     19 <ul>
     20 <li><a href="#percent">Percentage</a></li>
     21 <li><a href="#time">Time linear</a></li>
     22 <li><a href="#time">Time logarithmic</a></li>
     23 </ul>
     24 </li>
     25 <li><a href="#tips">Tips for time scales</a></li>
     26 </ul>
     27 </p>
     28 <h1><a name="scales">Scales</h1>
     29 Since 3.5, it's possible to see results in fingerprints with three different
     30 kinds of scale.
     31 <h3><a name="percent">Percentage scale</h3>
     32 <p>The X axis represents percentage of the variation vs. the given baseline</p>
     33 <p>This is the way fingerprints were displayed since the beginning:
     34 <p><img src="images/percentage.png">
     35 <ul>
     36 <li>Red bar means a regression, even if it's less than the 10% threshold.</li>
     37 <li>Green bar means an improvement</li>
     38 <li>Gray bar means an 'explained' regression.</li>
     39 </ul>
     40 </p>
     41 <h3><a name="time">Linear and logarithmic time scales</h3>
     42 <p>For these scales, the X axis represents the duration time of the test.<br>
     43 The colors meanings are the same than for the percentage scale.<br>
     44 These kind of graphs give a better idea of time duration for each test.</p>
     45 <p>Typically use linear scale if you want to see the tests relativeness for all the component tests:</p>
     46 <p><img src="images/linear.png">
     47 <p>But the logarithmic scale is more appropriate when there are a strong duration differences between tests, hence makes short duration tests easier to survey:</p>
     48 <p><img src="images/log.png">
     49 <p>Each test have two bars: the former is white and shows the baseline result, the latter is colored (red, green or gray) and shows the current build result.<br>
     50 The variation between the baseline and the build is displayed as a percentage on top of both bars.</p>
     51 <h1><a name="tips">Tips for time scales</h1>
     52 <p>Tips are almost the same for linear and logarithmic scales:</p>
     53 <table border="0">
     54   <tr>
     55     <td valign="top"><img src="../images/light.gif"></td>
     56     <td><b>Flying over a bar displays its time value<b>:</td></tr>
     57   </tr>
     58   <tr>
     59     <td></td>
     60     <td><img src="images/help_time_baseline.png"></td>
     61   </tr>
     62   <tr>
     63     <td></td>
     64     <td><img src="images/help_time_current.png"></td>
     65   </tr>
     66   <tr><td><br></td></tr>
     67   <tr>
     68     <td valign="top"><img src="../images/light.gif"></td>
     69     <td><b>For <u>linear scale only</u>, when the error on the time result is noticeable,
     70 		then the measurement uncertainty is shown in yellow at the end of the bar<b>:</td></tr>
     71   </tr>
     72   <tr>
     73     <td></td>
     74     <td><img src="images/help_time_error.png"></td>
     75   </tr>
     76   <tr><td><br></td></tr>
     77   <tr>
     78     <td valign="top"><img src="../images/light.gif"></td>
     79     <td><b>A performance regression may sometimes have a known good reason</b>.<br>
     80     In this case, the current build bar is grayed and flying over it also shows the given explanation:</td></tr>
     81   </tr>
     82   <tr>
     83     <td></td>
     84     <td><img src="images/help_explained_regression.png"></td>
     85   </tr>
     86   <tr><td><br></td></tr>
     87   <tr>
     88     <td valign="top"><img src="../images/light.gif"></td>
     89     <td><b>Test result may have big error which can make the test result not fully reliable</b>.<br>
     90   In this case, a warning icon is shown after the variation value and flying over it gives the offending error value:</td></tr>
     91   </tr>
     92   <tr>
     93     <td></td>
     94     <td><img src="images/help_error_warning.png"></td>
     95   </tr>
     96   <tr><td><br></td></tr>
     97   <tr>
     98     <td valign="top"><img src="../images/light.gif"></td>
     99     <td><b>Test may have no result for the used baseline, hence the first available build is used as a reference</b>.<br>
    100   In this case, a warning icon is shown after the scenario title and flying over it gives the build ID used to compute the variation:</td></tr>
    101   </tr>
    102   <tr>
    103     <td></td>
    104     <td><img src="images/help_no_baseline.png"></td>
    105   </tr>
    106 </table>
    107 </body>
    108 </html>
    109