1 ..  ============================================================================ 

     2     Name        : running.rst

     3     Part of     : Helium 

     4     

     5     Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     6     All rights reserved.

     7     This component and the accompanying materials are made available

     8     under the terms of the License "Eclipse Public License v1.0"

     9     which accompanies this distribution, and is available

    10     at the URL "http://www.eclipse.org/legal/epl-v10.html".

    11     

    12     Initial Contributors:

    13     Nokia Corporation - initial contribution.

    14     

    15     Contributors:

    16     

    17     Description:

    18     

    19     ============================================================================

    20 

    21 ###################

    22 Helium Introduction

    23 ###################

    24 

    25 .. index::

    26   module:  Introduction

    27 

    28 .. contents::

    29 

    30 .. index::

    31   single:  Introduction

    32 

    33 Introduction

    34 =============

    35 

    36 This is the manual for Helium, an Ant-based build framework used to build Symbian Devices products. This documentation describes how to configure and use the Helium build framework from the point of view of an IDO integrator, a build manager, a helium contributor and subcon user.

    37 

    38 Helium contains all you need in order to create a work area, a build area, perform the compilation, link, create localised variants, submit build information to Diamonds (used for statistical analysis), create Data Packages, zip the files to create a release and much more. The aim is for helium to be used by every build and release team working on Symbian products within Nokia. It is also used by some Subcons as part of the tool set given to them to allow subcons to build parts

    39 of the S60 code.

    40 

    41 It is recommended to read the Ant_ documentation before learning about Helium. An understanding of XML_ is also needed as Ant_ is configured using an XML_ format.

    42 

    43 .. _Ant: http://Ant.apache.org/

    44 .. _XML: http://www.w3.org/XML/

    45 

    46 .. index::

    47   single:  Vision

    48 

    49 Vision

    50 =========

    51 

    52 The Helium vision is to fulfill the following demands:

    53 

    54  * A "common unified toolset".

    55  * Easy to use and configure for all different builds.

    56    

    57    * Fully automated builds.

    58    * Verbose and clear messages.

    59  

    60  * Light.

    61  * Simple things should be easy to do, complex things should be possible.

    62 

    63 .. index::

    64   single:  Background

    65   

    66 Background

    67 ============

    68 

    69 Helium was developed from a need to reduce "reinventing the wheel" for build tools. It was based on the mc_tools project which had the same goal within the former MC organization.

    70 

    71 .. index::

    72   single:  Why Ant?

    73   

    74 Why Ant?

    75 ==========

    76 

    77 Helium is fundamentally based on Apache Ant_. Why was Ant_ chosen when there were many other similar frameworks inside Nokia,

    78 such as sbt, isis_build and TrombiBuild. The main reason is that while the other toolkits were developed inside Nokia,

    79 Ant_ is an open source tool from Apache, based on relatively simple XML_ files that define the build steps. 

    80 Through leveraging the power of open source Helium has integrated a large amount of functionality that would have taken

    81 much longer to develop in-house, as well as benefit from existing, high-quality documentation.

    82