doc/api/helium/overview-summary.html
changeset 432 f2ddfa555b0f
child 627 56a1d97e7c73
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 
       
     2 
       
     3 
       
     4 <?xml version="1.0" encoding="utf-8"?>
       
     5 <!DOCTYPE HTML PUBLIC "-//w3c//dtd xhtml 1.0 strict//en"
       
     6       "http://www.w3.org/tr/xhtml1/dtd/xhtml1-strict.dtd">
       
     7 <html xmlns="http://www.w3.org/1999/xhtml">
       
     8 
       
     9 
       
    10 <head>
       
    11     <meta name="keywords" content="helium"/>
       
    12     <meta http-equiv="content-type" content="text/html+xml; charset=iso-8859-1"/>
       
    13     <link rel="stylesheet" href="stylesheet.css" type="text/css" />
       
    14     <script type="text/javascript">
       
    15       var DOCUMENTATION_OPTIONS = {
       
    16         URL_ROOT:   '',
       
    17         VERSION:    '0'
       
    18       };
       
    19     </script>
       
    20     <script type="text/javascript" src="../_static/jquery.js"></script>
       
    21 
       
    22     <script type="text/javascript" src="../_static/interface.js"></script>
       
    23     <script type="text/javascript" src="../_static/doctools.js"></script>
       
    24     
       
    25     <title>Helium API</title>
       
    26 </head>
       
    27 
       
    28 
       
    29 <body>
       
    30 <!-- ========= start of top navbar ======= -->
       
    31 <a name="navbar_top"><!-- --></a>
       
    32 <a href="#skip-navbar_top" title="skip navigation links"></a>
       
    33 <table border="0" width="100%" cellpadding="1" cellspacing="0" summary="">
       
    34 <tr>
       
    35 <td colspan="2" bgcolor="#eeeeff" class="navbarcell1">
       
    36 <a name="navbar_top_firstrow"><!-- --></a>
       
    37 <table border="0" cellpadding="0" cellspacing="3" summary="">
       
    38   <tr align="center" valign="top">
       
    39   <td bgcolor="#ffffff" class="navbarcell1"> &#160;<a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font>&#160;</a></td>
       
    40 
       
    41   <td bgcolor="#ffffff" class="navbarcell1">    <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a>&#160;</td>
       
    42     
       
    43   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a>&#160;</td>  
       
    44   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a>&#160;</td>
       
    45   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="help.html"><font class="navbarfont1"><b>help</b></font></a>&#160;</td>
       
    46   </tr>
       
    47 </table>
       
    48 </td>
       
    49 <td align="right" valign="top" rowspan="3"><em>
       
    50 <b>Helium API</b></em>
       
    51 
       
    52 </td>
       
    53 </tr>
       
    54 
       
    55 <tr>
       
    56 <td bgcolor="white" class="navbarcell2"><font size="-2">
       
    57 &#160;prev&#160;
       
    58 &#160;next</font></td>
       
    59 <td bgcolor="white" class="navbarcell2"><font size="-2">
       
    60   <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>  &#160;
       
    61 &#160;<a href="overview-summary.html" target="_top"><b>no frames</b></a>  &#160;
       
    62 
       
    63 &#160;<script type="text/javascript">
       
    64   <!--
       
    65   if(window==top) {
       
    66     document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>');
       
    67   }
       
    68   //-->
       
    69 </script>
       
    70 <noscript>
       
    71   <a href="allclasses-noframe.html"><b>all classes</b></a>
       
    72 </noscript>
       
    73 
       
    74 
       
    75 </font></td>
       
    76 </tr>
       
    77 </table>
       
    78 <a name="skip-navbar_top"></a>
       
    79 <!-- ========= end of top navbar ========= -->
       
    80     <hr/>
       
    81 
       
    82 
       
    83     <center>
       
    84         <h1>Helium API</h1>
       
    85     </center>
       
    86     
       
    87     <p>
       
    88     This is the API specification for the Helium build toolkit.
       
    89     </p>
       
    90     
       
    91     <ul>
       
    92         <li><a href="#projects">Projects</a></li>
       
    93         <li><a href="#propertygroups">Property groups</a></li>
       
    94     </ul>
       
    95     
       
    96     <h2><a name="projects">Projects</a></h2>
       
    97     <p>
       
    98     Helium is configured into a set of Ant project files that group related functionality.
       
    99     </p>
       
   100     <table class="docutils">
       
   101         <tr>
       
   102             <th class="head">Project name</th>
       
   103             <th class="head">Description</th>
       
   104         </tr>
       
   105             <tr>
       
   106                 <td><a href="project-SF-COMMON-CONFIG.html" target="classframe">SF-COMMON-CONFIG</a></td>
       
   107                 <td></td>
       
   108             </tr>
       
   109             <tr>
       
   110                 <td><a href="project-SF-COMMON-TEST.html" target="classframe">SF-COMMON-TEST</a></td>
       
   111                 <td></td>
       
   112             </tr>
       
   113             <tr>
       
   114                 <td><a href="project-SF-CONFIG.html" target="classframe">SF-CONFIG</a></td>
       
   115                 <td></td>
       
   116             </tr>
       
   117             <tr>
       
   118                 <td><a href="project-SF-PLATFORM-CONFIG.html" target="classframe">SF-PLATFORM-CONFIG</a></td>
       
   119                 <td></td>
       
   120             </tr>
       
   121             <tr>
       
   122                 <td><a href="project-SF-POSTBUILD.html" target="classframe">SF-POSTBUILD</a></td>
       
   123                 <td></td>
       
   124             </tr>
       
   125             <tr>
       
   126                 <td><a href="project-SF-SOURCESPEC.html" target="classframe">SF-SOURCESPEC</a></td>
       
   127                 <td></td>
       
   128             </tr>
       
   129     </table>
       
   130     <br/>
       
   131     
       
   132     <h2><a name="propertygroups">Property groups</a></h2>
       
   133     <p>
       
   134     Property groups define a set of properties that relate to a specific feature or functionality in Helium.
       
   135     </p>
       
   136     <table class="docutils">
       
   137         <tr>
       
   138             <th class="head">Property group name</th>
       
   139             <th class="head">Description</th>
       
   140         </tr>
       
   141             <tr>
       
   142                 <td><a href="propertygroup-Environment.html" target="classframe">Environment</a></td>
       
   143                 <td></td>
       
   144             </tr>
       
   145             <tr>
       
   146                 <td><a href="propertygroup-Policy validation.html" target="classframe">Policy validation</a></td>
       
   147                 <td><p>Properties which drive the policy validation.</p></td>
       
   148             </tr>
       
   149             <tr>
       
   150                 <td><a href="propertygroup-preparation.html" target="classframe">preparation</a></td>
       
   151                 <td><p>Preparing the build area.</p></td>
       
   152             </tr>
       
   153             <tr>
       
   154                 <td><a href="propertygroup-localFreeSpace.html" target="classframe">localFreeSpace</a></td>
       
   155                 <td><p>Checking for disk space on local machine.</p></td>
       
   156             </tr>
       
   157             <tr>
       
   158                 <td><a href="propertygroup-remoteFreeSpace.html" target="classframe">remoteFreeSpace</a></td>
       
   159                 <td><p>Checking for disk space on network disk.</p></td>
       
   160             </tr>
       
   161             <tr>
       
   162                 <td><a href="propertygroup-compilation.html" target="classframe">compilation</a></td>
       
   163                 <td><p>Main compilation.</p></td>
       
   164             </tr>
       
   165             <tr>
       
   166                 <td><a href="propertygroup-sisFiles.html" target="classframe">sisFiles</a></td>
       
   167                 <td><p>Creating SIS files.</p></td>
       
   168             </tr>
       
   169             <tr>
       
   170                 <td><a href="propertygroup-rombuild.html" target="classframe">rombuild</a></td>
       
   171                 <td><p>Creating ROM images.</p></td>
       
   172             </tr>
       
   173             <tr>
       
   174                 <td><a href="propertygroup-subcon.html" target="classframe">subcon</a></td>
       
   175                 <td><p>Creating a subcon build area and testing the creation of subcon images.</p></td>
       
   176             </tr>
       
   177             <tr>
       
   178                 <td><a href="propertygroup-archive.html" target="classframe">archive</a></td>
       
   179                 <td><p>Zipping the build area.</p></td>
       
   180             </tr>
       
   181             <tr>
       
   182                 <td><a href="propertygroup-publish.html" target="classframe">publish</a></td>
       
   183                 <td><p>Publishing the build to the network.</p></td>
       
   184             </tr>
       
   185             <tr>
       
   186                 <td><a href="propertygroup-mobilecrash.html" target="classframe">mobilecrash</a></td>
       
   187                 <td><p>Mobilecrash configuration.</p></td>
       
   188             </tr>
       
   189             <tr>
       
   190                 <td><a href="propertygroup-ReleaseNotes.html" target="classframe">ReleaseNotes</a></td>
       
   191                 <td><p>Release notes generation.</p></td>
       
   192             </tr>
       
   193             <tr>
       
   194                 <td><a href="propertygroup-DeltaZip.html" target="classframe">DeltaZip</a></td>
       
   195                 <td></td>
       
   196             </tr>
       
   197             <tr>
       
   198                 <td><a href="propertygroup-CCM.html" target="classframe">CCM</a></td>
       
   199                 <td></td>
       
   200             </tr>
       
   201             <tr>
       
   202                 <td><a href="propertygroup-EC.html" target="classframe">EC</a></td>
       
   203                 <td></td>
       
   204             </tr>
       
   205             <tr>
       
   206                 <td><a href="propertygroup-cMaker.html" target="classframe">cMaker</a></td>
       
   207                 <td></td>
       
   208             </tr>
       
   209             <tr>
       
   210                 <td><a href="propertygroup-IDO - Codescanner.html" target="classframe">IDO - Codescanner</a></td>
       
   211                 <td><p>Codescanner related Ant properties.</p></td>
       
   212             </tr>
       
   213             <tr>
       
   214                 <td><a href="propertygroup-iMaker - integration.html" target="classframe">iMaker - integration</a></td>
       
   215                 <td><p>New iMaker integration support.</p></td>
       
   216             </tr>
       
   217             <tr>
       
   218                 <td><a href="propertygroup-ImageTool.html" target="classframe">ImageTool</a></td>
       
   219                 <td><p>ImageTool configuration.</p></td>
       
   220             </tr>
       
   221             <tr>
       
   222                 <td><a href="propertygroup-Diamonds.html" target="classframe">Diamonds</a></td>
       
   223                 <td></td>
       
   224             </tr>
       
   225             <tr>
       
   226                 <td><a href="propertygroup-Localisation.html" target="classframe">Localisation</a></td>
       
   227                 <td></td>
       
   228             </tr>
       
   229             <tr>
       
   230                 <td><a href="propertygroup-ATS.html" target="classframe">ATS</a></td>
       
   231                 <td></td>
       
   232             </tr>
       
   233             <tr>
       
   234                 <td><a href="propertygroup-Company.html" target="classframe">Company</a></td>
       
   235                 <td></td>
       
   236             </tr>
       
   237             <tr>
       
   238                 <td><a href="propertygroup-Release.html" target="classframe">Release</a></td>
       
   239                 <td></td>
       
   240             </tr>
       
   241             <tr>
       
   242                 <td><a href="propertygroup-Qt.html" target="classframe">Qt</a></td>
       
   243                 <td></td>
       
   244             </tr>
       
   245             <tr>
       
   246                 <td><a href="propertygroup-Misc.html" target="classframe">Misc</a></td>
       
   247                 <td></td>
       
   248             </tr>
       
   249     </table>    
       
   250 
       
   251     <hr/>
       
   252 <!-- ========= start of top navbar ======= -->
       
   253 <a name="navbar_top"><!-- --></a>
       
   254 <a href="#skip-navbar_top" title="skip navigation links"></a>
       
   255 <table border="0" width="100%" cellpadding="1" cellspacing="0" summary="">
       
   256 <tr>
       
   257 <td colspan="2" bgcolor="#eeeeff" class="navbarcell1">
       
   258 <a name="navbar_top_firstrow"><!-- --></a>
       
   259 <table border="0" cellpadding="0" cellspacing="3" summary="">
       
   260   <tr align="center" valign="top">
       
   261   <td bgcolor="#ffffff" class="navbarcell1"> &#160;<a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font>&#160;</a></td>
       
   262 
       
   263   <td bgcolor="#ffffff" class="navbarcell1">    <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a>&#160;</td>
       
   264     
       
   265   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a>&#160;</td>  
       
   266   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a>&#160;</td>
       
   267   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="help.html"><font class="navbarfont1"><b>help</b></font></a>&#160;</td>
       
   268   </tr>
       
   269 </table>
       
   270 </td>
       
   271 <td align="right" valign="top" rowspan="3"><em>
       
   272 <b>Helium API</b></em>
       
   273 
       
   274 </td>
       
   275 </tr>
       
   276 
       
   277 <tr>
       
   278 <td bgcolor="white" class="navbarcell2"><font size="-2">
       
   279 &#160;prev&#160;
       
   280 &#160;next</font></td>
       
   281 <td bgcolor="white" class="navbarcell2"><font size="-2">
       
   282   <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>  &#160;
       
   283 &#160;<a href="overview-summary.html" target="_top"><b>no frames</b></a>  &#160;
       
   284 
       
   285 &#160;<script type="text/javascript">
       
   286   <!--
       
   287   if(window==top) {
       
   288     document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>');
       
   289   }
       
   290   //-->
       
   291 </script>
       
   292 <noscript>
       
   293   <a href="allclasses-noframe.html"><b>all classes</b></a>
       
   294 </noscript>
       
   295 
       
   296 
       
   297 </font></td>
       
   298 </tr>
       
   299 </table>
       
   300 <a name="skip-navbar_top"></a>
       
   301 <!-- ========= end of top navbar ========= -->
       
   302     <font size="-2">Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: http://www.eclipse.org/legal/epl-v10.html</font>
       
   303  </body>
       
   304 
       
   305 </html>
       
   306