doc/api/helium/overview-summary.html
author Simon Howkins <simonh@symbian.org>
Mon, 05 Oct 2009 15:17:20 +0100
changeset 587 97d29037659e
parent 432 f2ddfa555b0f
child 627 56a1d97e7c73
permissions -rw-r--r--
Added schema setting, so Diamonds should accept the data.




<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE HTML PUBLIC "-//w3c//dtd xhtml 1.0 strict//en"
      "http://www.w3.org/tr/xhtml1/dtd/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">


<head>
    <meta name="keywords" content="helium"/>
    <meta http-equiv="content-type" content="text/html+xml; charset=iso-8859-1"/>
    <link rel="stylesheet" href="stylesheet.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:   '',
        VERSION:    '0'
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>

    <script type="text/javascript" src="../_static/interface.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    
    <title>Helium API</title>
</head>


<body>
<!-- ========= start of top navbar ======= -->
<a name="navbar_top"><!-- --></a>
<a href="#skip-navbar_top" title="skip navigation links"></a>
<table border="0" width="100%" cellpadding="1" cellspacing="0" summary="">
<tr>
<td colspan="2" bgcolor="#eeeeff" class="navbarcell1">
<a name="navbar_top_firstrow"><!-- --></a>
<table border="0" cellpadding="0" cellspacing="3" summary="">
  <tr align="center" valign="top">
  <td bgcolor="#ffffff" class="navbarcell1"> &#160;<a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font>&#160;</a></td>

  <td bgcolor="#ffffff" class="navbarcell1">    <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a>&#160;</td>
    
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a>&#160;</td>  
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a>&#160;</td>
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="help.html"><font class="navbarfont1"><b>help</b></font></a>&#160;</td>
  </tr>
</table>
</td>
<td align="right" valign="top" rowspan="3"><em>
<b>Helium API</b></em>

</td>
</tr>

<tr>
<td bgcolor="white" class="navbarcell2"><font size="-2">
&#160;prev&#160;
&#160;next</font></td>
<td bgcolor="white" class="navbarcell2"><font size="-2">
  <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>  &#160;
&#160;<a href="overview-summary.html" target="_top"><b>no frames</b></a>  &#160;

&#160;<script type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>');
  }
  //-->
</script>
<noscript>
  <a href="allclasses-noframe.html"><b>all classes</b></a>
</noscript>


</font></td>
</tr>
</table>
<a name="skip-navbar_top"></a>
<!-- ========= end of top navbar ========= -->
    <hr/>


    <center>
        <h1>Helium API</h1>
    </center>
    
    <p>
    This is the API specification for the Helium build toolkit.
    </p>
    
    <ul>
        <li><a href="#projects">Projects</a></li>
        <li><a href="#propertygroups">Property groups</a></li>
    </ul>
    
    <h2><a name="projects">Projects</a></h2>
    <p>
    Helium is configured into a set of Ant project files that group related functionality.
    </p>
    <table class="docutils">
        <tr>
            <th class="head">Project name</th>
            <th class="head">Description</th>
        </tr>
            <tr>
                <td><a href="project-SF-COMMON-CONFIG.html" target="classframe">SF-COMMON-CONFIG</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="project-SF-COMMON-TEST.html" target="classframe">SF-COMMON-TEST</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="project-SF-CONFIG.html" target="classframe">SF-CONFIG</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="project-SF-PLATFORM-CONFIG.html" target="classframe">SF-PLATFORM-CONFIG</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="project-SF-POSTBUILD.html" target="classframe">SF-POSTBUILD</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="project-SF-SOURCESPEC.html" target="classframe">SF-SOURCESPEC</a></td>
                <td></td>
            </tr>
    </table>
    <br/>
    
    <h2><a name="propertygroups">Property groups</a></h2>
    <p>
    Property groups define a set of properties that relate to a specific feature or functionality in Helium.
    </p>
    <table class="docutils">
        <tr>
            <th class="head">Property group name</th>
            <th class="head">Description</th>
        </tr>
            <tr>
                <td><a href="propertygroup-Environment.html" target="classframe">Environment</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-Policy validation.html" target="classframe">Policy validation</a></td>
                <td><p>Properties which drive the policy validation.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-preparation.html" target="classframe">preparation</a></td>
                <td><p>Preparing the build area.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-localFreeSpace.html" target="classframe">localFreeSpace</a></td>
                <td><p>Checking for disk space on local machine.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-remoteFreeSpace.html" target="classframe">remoteFreeSpace</a></td>
                <td><p>Checking for disk space on network disk.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-compilation.html" target="classframe">compilation</a></td>
                <td><p>Main compilation.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-sisFiles.html" target="classframe">sisFiles</a></td>
                <td><p>Creating SIS files.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-rombuild.html" target="classframe">rombuild</a></td>
                <td><p>Creating ROM images.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-subcon.html" target="classframe">subcon</a></td>
                <td><p>Creating a subcon build area and testing the creation of subcon images.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-archive.html" target="classframe">archive</a></td>
                <td><p>Zipping the build area.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-publish.html" target="classframe">publish</a></td>
                <td><p>Publishing the build to the network.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-mobilecrash.html" target="classframe">mobilecrash</a></td>
                <td><p>Mobilecrash configuration.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-ReleaseNotes.html" target="classframe">ReleaseNotes</a></td>
                <td><p>Release notes generation.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-DeltaZip.html" target="classframe">DeltaZip</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-CCM.html" target="classframe">CCM</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-EC.html" target="classframe">EC</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-cMaker.html" target="classframe">cMaker</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-IDO - Codescanner.html" target="classframe">IDO - Codescanner</a></td>
                <td><p>Codescanner related Ant properties.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-iMaker - integration.html" target="classframe">iMaker - integration</a></td>
                <td><p>New iMaker integration support.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-ImageTool.html" target="classframe">ImageTool</a></td>
                <td><p>ImageTool configuration.</p></td>
            </tr>
            <tr>
                <td><a href="propertygroup-Diamonds.html" target="classframe">Diamonds</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-Localisation.html" target="classframe">Localisation</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-ATS.html" target="classframe">ATS</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-Company.html" target="classframe">Company</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-Release.html" target="classframe">Release</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-Qt.html" target="classframe">Qt</a></td>
                <td></td>
            </tr>
            <tr>
                <td><a href="propertygroup-Misc.html" target="classframe">Misc</a></td>
                <td></td>
            </tr>
    </table>    

    <hr/>
<!-- ========= start of top navbar ======= -->
<a name="navbar_top"><!-- --></a>
<a href="#skip-navbar_top" title="skip navigation links"></a>
<table border="0" width="100%" cellpadding="1" cellspacing="0" summary="">
<tr>
<td colspan="2" bgcolor="#eeeeff" class="navbarcell1">
<a name="navbar_top_firstrow"><!-- --></a>
<table border="0" cellpadding="0" cellspacing="3" summary="">
  <tr align="center" valign="top">
  <td bgcolor="#ffffff" class="navbarcell1"> &#160;<a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font>&#160;</a></td>

  <td bgcolor="#ffffff" class="navbarcell1">    <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a>&#160;</td>
    
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a>&#160;</td>  
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a>&#160;</td>
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="help.html"><font class="navbarfont1"><b>help</b></font></a>&#160;</td>
  </tr>
</table>
</td>
<td align="right" valign="top" rowspan="3"><em>
<b>Helium API</b></em>

</td>
</tr>

<tr>
<td bgcolor="white" class="navbarcell2"><font size="-2">
&#160;prev&#160;
&#160;next</font></td>
<td bgcolor="white" class="navbarcell2"><font size="-2">
  <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>  &#160;
&#160;<a href="overview-summary.html" target="_top"><b>no frames</b></a>  &#160;

&#160;<script type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>');
  }
  //-->
</script>
<noscript>
  <a href="allclasses-noframe.html"><b>all classes</b></a>
</noscript>


</font></td>
</tr>
</table>
<a name="skip-navbar_top"></a>
<!-- ========= end of top navbar ========= -->
    <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>
 </body>

</html>