core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/working_with_sis_pkg_files.htm
author fturovic <frank.turovich@nokia.com>
Wed, 21 Jul 2010 13:50:58 -0500
changeset 1658 2a5c0df13bad
parent 1376 120480c02651
child 1791 727385d8e2b3
permissions -rw-r--r--
renamed files for consistency in naming
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     2
<html>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     3
<head>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     4
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     5
<meta http-equiv="Content-Style-Type" content="text/css" />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     6
<meta name="LASTUPDATED" content="06/17/05 11:09:43" />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     7
<title>Working with PKG and SIS Files</title>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     8
<link rel="StyleSheet" href="../../../book.css" type="text/css"/>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     9
</head>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    10
<body bgcolor="#FFFFFF">
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    11
<h2>Creating a PKG  File</h2>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    12
<p>After creating a project for the application you are developing for a device,  you will need to create a .pkg file if you are using Application TRK. A .pkg file contains all the files that will need to be downloaded to the device.   Once a .pkg file is available, you can add it to a project, and the IDE will use it and additional information entered in the <a href="../../reference/build_properties/pane_build_config_sis.htm">SIS Builder</a> pane  to create an application's .sis installation file. By default, when creating a project, the .pkg file is located in the project's <b>sis</b> folder.</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    13
<p>A minimal .pkg file consists of the following lines:</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    14
<ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    15
  <li>Header &mdash; provides the following information on a single line:
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    16
    <ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    17
      <li>application name &mdash; name of the application displayed on the target device</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    18
      <li>UID &mdash; (0x10004299) unique application ID value</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    19
      <li>major and minor version numbers &mdash; values that represent the application's major and minor version numbers</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    20
      <li>current build number &mdash; value that represents the current .sis build number</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    21
    </ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    22
  </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    23
  <li>Filenames and install location &mdash; the name of the file to include in the .sis file and its install location within the target device. Each line describes a single file.</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    24
  <li>Comments &mdash; .pkg file comment lines are preceeded by a semi-colon</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    25
</ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    26
<h3>PKG File Symbols </h3>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    27
<p>Carbide.c++  attempts to build SIS files for the current build configuration  when a PKG file exists in a given build project. However, there can be one or more SIS file per project but only one can be selected in the <a href="../../projects/launch/page_installation.htm">Installation</a> pane for downloading and debugging. We have introduced symbols you can use within your PKG file for Carbide so that you can use one PKG file in a project to produce several different SIS files, if required.</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    28
<p>The following symbols are available for PKG files in order to make reuse of PKG files more efficient across build targets. These symbols are only supported within Carbide.c++. They are:</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    29
<ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    30
  <li><span class="code">$(EPOCROOT)</span> &mdash; the location of the epoc32 folder but not including the epoc32 folder</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    31
  <li><span class="code">$(PLATFORM)</span> &mdash; platform designator, for example: ARMI, WINSC (Emulator) , GCCE, THUMB, etc.</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    32
  <li><span class="code">$(TARGET)</span> &mdash; target designator UDEB (Debug) or UREL (Release)</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    33
</ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    34
<p>These symbols are used to specify the input location of file resources on your host PC to be packaged in the SIS file. </p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    35
<h4>Sample PKG file</h4>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    36
<p>A sample .pkg file might look like this:</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    37
<p class="listing">;Header<br />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    38
  #{&quot;HelloWorld&quot;},(0xA0004299),1,0,0<br>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    39
  <br />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    40
&quot;$(EPOCROOT)epoc32\release\$(PLATFORM)\$(TARGET)\HelloWorld.exe&quot; -&quot;!:\sys\bin\HelloWorld.exe&quot;<br />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    41
&quot;$(EPOCROOT)epoc32\data\z\resource\apps\HelloWorld.rsc&quot; -&quot;!:\resource\apps\HelloWorld.rsc&quot;<br />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    42
&quot;$(EPOCROOT)epoc32\data\z\private\10003af\import\apps\HelloWorld_reg.rsc&quot; - &quot;!:\private\10003a3f\import\apps\HelloWorld_reg.rsc&quot;<br />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    43
&quot;$(EPOCROOT)epoc32\data\z\resource\apps\HelloWorld.mbm&quot; -&quot;!:\resource\apps\HelloWorld.mbm&quot;</p>
1658
2a5c0df13bad renamed files for consistency in naming
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    44
<p>In addition you will need to add the PKG file to the project before building the final application. Add the pkg file in the SIS builder tab of the <a href="../../reference/build_properties/prop_carb_build_config.htm">Carbide Build Configurations</a> in the project properties window.</p>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    45
<h5>Related references </h5>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    46
<ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    47
  <li><a href="../../reference/build_properties/pane_build_config_sis.htm">SIS Builder</a> pane</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    48
  <li><a href="../../reference/build_properties/wnd_sis_properties.htm">SIS Properties</a></li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    49
</ul>
1376
120480c02651 BUG 10758 - copyright revised date to 2010
fturovic <frank.turovich@nokia.com>
parents: 400
diff changeset
    50
<div id="footer">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    51
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    52
</body>
0
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    53
</html>