imakerplugin/com.nokia.s60tools.imaker.doc.user/html/tasks/taskPreferences.html
author haismail <hussein.ismail@nokia.com>
Wed, 28 Apr 2010 13:50:48 +0300
changeset 11 217e69fc5beb
parent 0 61163b28edca
permissions -rw-r--r--
iMaker 3.1.0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     2
<?Pub Inc>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     3
<html>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     4
<head>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     5
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     6
<meta http-equiv="content-style-type" content="text/css" />
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     7
<title>Managing preferences</title>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     8
<link href="../book.css" type="text/css" rel="stylesheet" />
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     9
</head>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    10
<body>
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    11
<h2>Managing image creation preferences</h2>  
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    12
<p>Before you can build a ROM image, you must define the preferences for a configuration. In iMaker,
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    13
a configuration can be thought of as a container of product and other information. Follow these steps to create a ROM image with the specified settings:</p> 
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    14
<ol>
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    15
<li>Select the project that you want to use as the basis for image creation from carbide.c++ <i>Project Explorer</i> view. </li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    16
<li>Select <b>Open iMaker Dialog...</b> option from the iMaker pulldown menu on the toolbar see below image. <p><img src="images/launch_imaker.png"></p> iMaker Extension will now start scanning the environtment to query 
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    17
information from the underlying iMaker commandline tool. This may take a while, but this action occurs only once for each project.</li>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    18
<li>When the <b>iMaker Dialog</b> is opened, it is populated with data from the active environment. Default product is selected if one is configured, otherwise the first product is selected. 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    19
User can change the product using the <b>Change...</b> button. Example is shown bellow. <p><img
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    20
src="images/iMakerPluginPreferences.png"></p></li>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    21
<li>Once data is filled in the fields, a flashable image can be created. Press
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    22
the <b>Run</b> button at the bottom of the dialog. Remember to add the desired targets to the <b>selected</b> list of targets. Usual targets include <i>flash</i>, <i>core</i>, <i>variant</i> etc..</li>
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    23
</ol> 
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    24
<a name="config"></a><h3>Saving the preferences</h3> 
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    25
<p>To save the specified data values in the dialog to a file, do the following: </p><ol>
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    26
<li>Press the <b>Save as...</b></li>
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    27
<li>Choose the parent folder where to save the file, it is recommended to save under the selected project. See below image.<p><img src="images/iMakerPluginSaveAction.png"></p> Specify name and press <i>finish</i></li>
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    28
<li>All saved preferences are visible in the <b>configuration</b> combobox on the top of the dialog. Any of these saved files can be activated and used for image creation.</li>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    29
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    30
<a name="settings"></a><h3>Settings tab</h3> <p>To modify the values
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    31
of the variables of the selected product (or makefile), select the <b>Settings
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    32
</b> tab in the iMaker dialog. See the following example: </p><p><img src="images/iMakerPluginPreferencesDetails.png"> </p> Through this tab user can override the default variable values in the iMaker core. Any modified parameter will be passed to iMaker cmd through execution command. 
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    33
11
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    34
<a name="debug"></a><h3>Content tab</h3>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    35
<p>The content tab allows user to add binary and data files to the image. These files can be added to different sections of the image. Currently CORE and ROFS sections are supported. Files can also be removed, hidden or changes to udeb/urel version. The <b>Action</b>s column provides the list of available actions.  
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    36
Files cannot be added to UDA through this tab.<br>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    37
<img src="images/content_tab.png"></p>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    38
<p><a name="fields"></a>Table fields:
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    39
<ul>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    40
<li><b>Enable</b>: Enablement, only enabled items are saved or taken to the image</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    41
<li><b>File</b>: Component source location. The source file must exist in the file system.</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    42
<li><b>Target</b>: Component target location in the device.</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    43
<li><b>Location</b>: Image section. Possible values: <ul><li><i>core</i> - core section of the image</li><li><i>rofs2</i> - rofs2 section of the image</li><li><i>rofs3</i> - rofs3 or customer section of the image</li></ul></li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    44
<li><b>Action</b>: Action to perform with the component. Possible values: <ul><li><i>udeb</i> - take udeb version of the component to the image</li><li><i>udeb-add</i> - take udeb version of the component, add the component to the specified image section if it is not already there</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    45
<li><i>urel</i> - take urel version of the component to the image</li><li><i>urel-add</i> - take urel version of the component, add the component to the specified image section if it is not already there</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    46
<li><i>remove</i> - remove the component from the specified image section</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    47
<li><i>hide</i> - hide the component in the specified image section</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    48
<li><i>replace</i> - replace the component in the image section specified, if the component does not exist then do nothing</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    49
<li><i>replace-add</i> - Replace the component in the image section specified, if the component does not exist then add it as a new component</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    50
</ul></li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    51
</ul>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    52
</p>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    53
<p><a name="buttons"></a>Right buttons:
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    54
<ul>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    55
<li><b>Add</b>: Add a new component to the list, causes a dialog to pop-up</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    56
<li><b>Remove</b>: Remove selected component from the list</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    57
<li><b>Duplicate</b>: Duplicate the selected component e.g. add a new entry with same <i>File</i> and <i>Target</i> as the selected one. The entry is added below the selected entry</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    58
<li><b>Populate</b>: Add the binaries and any resource-type files generated by all mmp files in the selected project</li>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    59
</ul>
217e69fc5beb iMaker 3.1.0
haismail <hussein.ismail@nokia.com>
parents: 0
diff changeset
    60
</p>
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    61
<a name="platsim"></a><h3>Platsim tab</h3>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    62
<p>The contents of the platsim tab will be enabled, when you select a valid platsim configuration from the main tab. The platsim configuration must define USE_PLATSIM variable, in order it to be 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    63
consider as valid. This variable must be non-empty. Users can edit the platsim configuration makefile and add USE_PLATSIM=1 then restart carbide.c++. Currently only all target is supported. All 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    64
target creates an image, which contains all image sections (core, rofsx, ...) and configures the selected platsim instance with the created image. Selecting (run platsim after image creation) checkbox causes 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    65
platsim instance to be started in the end of the image creation process.<br>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    66
<img src="images/platsim_tab.png"> </p> 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    67
<div id="footer">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. 	License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.</div>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    68
</body>
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    69
</html>