buildframework/helium/doc/src/manual/stage_post_build.rst.inc.ftl
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
<#--
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
============================================================================ 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
Name        : stage_post_build.rst.inc.ftl
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
Part of     : Helium 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
Description:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
============================================================================
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
-->
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
.. index::
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
  single: Stage - Post Build
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
Stage: Post Build
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
=================
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
.. index::
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
  single: SIS Files
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
Sis Files
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
---------
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
SIS files can be built during the postbuild stage. The :hlm-p:`sis.config.file` property defines the path to a :ref:`common-configuration-format-label` file, e.g.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
.. code-block:: xml
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
    <build>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
        <config abstract="true">
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
            <set name="makesis.tool" value="${r'$'}{build.drive}\epoc32\tools\makesis.exe"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
            <set name="signsis.tool" value="${r'$'}{build.drive}\epoc32\tools\signsis.exe"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
            <set name="build.sisfiles.dir" value="${r'$'}{build.sisfiles.dir}"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
            <set name="key" value="${r'$'}{build.drive}\s60\tools\taskmgr\internal\sis\RDTest_02.key"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
            <set name="cert" value="${r'$'}{build.drive}\s60\tools\taskmgr\internal\sis\RDTest_02.der"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
            <config>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
                <set name="name" value="ScreenGrabber_3"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
                <set name="path" value="${r'$'}{build.drive}\s60\tools\screengrabber\sis"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
            </config>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
            <config>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
                <set name="name" value="app_trk"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
                <set name="path" value="${r'$'}{build.drive}\s60\tools\trk\sis"/>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
            </config>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
        </config>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
    </build>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
The propertes are:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
.. csv-table:: Property descriptions
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
   :header: "Property", "Description", "Values"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
   "``makesis.tool``", "The path for the makesis tool that builds a .sis file.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
   "``signsis.tool``", "The path for the signsis tool that signs a .sis file to create a .sisx file.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
   "``publish.unsigned``", "This will copy .sis files into ${r'$'}{build.output.dir}/sisfiles.", "true, false"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
   "``build.sisfiles.dir``", "The directory where the .sis file should be put.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
   "``key``", "The key to use for signing.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
   "``cert``", "The certificate to use for signing.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
   "``name``", "The name of the .pkg file to parse.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
   "``sis.name``", "The name of the .sis file to create. If omitted it will default to the name of the .pkg file.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
   "``path``", "The path where the .pkg file exists as input to building the .sis file.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
   
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
Configuration enhancements
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
::::::::::::::::::::::::::
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
*Since Helium 7.0.*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
The configuration method above will be replaced by a more flexible approach:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
.. csv-table:: Property descriptions
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
   :header: "Property", "Description", "Values"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
   "``makesis.tool``", "The path for the makesis tool that builds a .sis file.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
   "``signsis.tool``", "The path for the signsis tool that signs a .sis file to create a .sisx file.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
   "``build.sisfiles.dir``", "The directory where the .sis file should be put.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
   "``key``", "The key to use for signing.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
   "``cert``", "The certificate to use for signing.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
   "``input``", "The full path and filename of the input file. This can be a .pkg file, for generating a SIS file, a .sis file for signing, or a .sisx file for multiple signing.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
   "``output``", "The full path and filename of the output file. This is only needed if the location or name needs to be different from the default, which is that the file extension changes appropriately.", ""
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
Also a ``sis.config.name`` property is added that allows the name of a <config> block to be supplied. This can be overridden to allow particular subsets of configurations to be built.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
Checking Stub SIS files
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
-----------------------
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
This step involves checking stub sis files published to ``z:/epoc32/data/z/system/install`` and it ensures that only valid stub sis files are published.The target is included in postbuild and using ParseStubSis.pl script to do the work, it will run automatically and save the output in stubresult.log.xml. It can also be run from the command line by using::
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
    hlm check-stub-sis
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    97
It checks all files in the target folder and renames the invalid sis files with ``.bak`` extention.