6 <meta http-equiv="content-style-type" content="text/css" /> |
6 <meta http-equiv="content-style-type" content="text/css" /> |
7 <title>Managing preferences</title> |
7 <title>Managing preferences</title> |
8 <link href="../book.css" type="text/css" rel="stylesheet" /> |
8 <link href="../book.css" type="text/css" rel="stylesheet" /> |
9 </head> |
9 </head> |
10 <body> |
10 <body> |
11 <h2>Managing preferences</h2> |
11 <h2>Managing image creation preferences</h2> |
12 <p>Before you can build a ROM image, you must define the preferences for a configuration. In iMaker, |
12 <p>Before you can build a ROM image, you must define the preferences for a configuration. In iMaker, |
13 a configuration can be thought of as a container of product and other information.</p> |
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> |
14 <ol> |
14 <ol> |
15 <li>Select the project that you want to use as the basis for image creation. </li> |
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> |
16 <li>Select <b>Open iMaker Dialog...</b> option from the iMaker pulldown menu on the toolbar. iMaker Extension will now start scanning the environtment to query |
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 |
17 information from the underlying iMaker commandline tool. This may take a while, but this action occurs only once for each project.</li> |
17 information from the underlying iMaker commandline tool. This may take a while, but this action occurs only once for each project.</li> |
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. |
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. |
19 User can change the product using the <b>Change...</b> button. Example is shown bellow. <p><img |
19 User can change the product using the <b>Change...</b> button. Example is shown bellow. <p><img |
20 src="images/iMakerPluginPreferences.png"></p></li> |
20 src="images/iMakerPluginPreferences.png"></p></li> |
21 <li>Once data is filled in the fields, a flashable image can be created. Press |
21 <li>Once data is filled in the fields, a flashable image can be created. Press |
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.</li> |
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> |
23 </ol> |
23 </ol> |
24 <h3>Saving the preferences for a configuration</h3> |
24 <a name="config"></a><h3>Saving the preferences</h3> |
25 <p>To save the fields of a configuration to a file, do the following: </p><ol> |
25 <p>To save the specified data values in the dialog to a file, do the following: </p><ol> |
26 <li>Press the <b>Save as...</b></li> |
26 <li>Press the <b>Save as...</b></li> |
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></li> |
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> |
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> |
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> |
29 |
29 |
30 <a name="management"></a><h3>Settings tab</h3> <p>To modify the values |
30 <a name="settings"></a><h3>Settings tab</h3> <p>To modify the values |
31 of the variables of the selected product (or makefile), select the <b>Settings |
31 of the variables of the selected product (or makefile), select the <b>Settings |
32 </b> tab in the iMaker dialog. See the following example: </p><p><img src="images/iMakerPluginPreferencesDetails.png"> Through this tab user can override the default variable values in the iMaker core. Any modified parameter will be passed to iMaker cmd throuht execution command.</p> |
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. |
33 |
33 |
34 <a name="debug"></a><h3>Debug tab</h3> |
34 <a name="debug"></a><h3>Content tab</h3> |
35 <p>The debug tab allows user to add binary and data files to the image. These files can be added to different sections of the image. The binary files can be easy changed to debug versions. Currently CORE and ROFS sections are supported. |
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. |
36 Files cannot be added to UDA for example through this tab.<br> |
36 Files cannot be added to UDA through this tab.<br> |
37 <img src="images/debug_tab.png"></p> |
37 <img src="images/content_tab.png"></p> |
38 |
38 <p><a name="fields"></a>Table fields: |
|
39 <ul> |
|
40 <li><b>Enable</b>: Enablement, only enabled items are saved or taken to the image</li> |
|
41 <li><b>File</b>: Component source location. The source file must exist in the file system.</li> |
|
42 <li><b>Target</b>: Component target location in the device.</li> |
|
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> |
|
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> |
|
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> |
|
46 <li><i>remove</i> - remove the component from the specified image section</li> |
|
47 <li><i>hide</i> - hide the component in the specified image section</li> |
|
48 <li><i>replace</i> - replace the component in the image section specified, if the component does not exist then do nothing</li> |
|
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> |
|
50 </ul></li> |
|
51 </ul> |
|
52 </p> |
|
53 <p><a name="buttons"></a>Right buttons: |
|
54 <ul> |
|
55 <li><b>Add</b>: Add a new component to the list, causes a dialog to pop-up</li> |
|
56 <li><b>Remove</b>: Remove selected component from the list</li> |
|
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> |
|
58 <li><b>Populate</b>: Add the binaries and any resource-type files generated by all mmp files in the selected project</li> |
|
59 </ul> |
|
60 </p> |
39 <a name="platsim"></a><h3>Platsim tab</h3> |
61 <a name="platsim"></a><h3>Platsim tab</h3> |
40 <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 |
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 |
41 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 |
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 |
42 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 |
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 |
43 platsim instance to be started in the end of the image creation process.<br> |
65 platsim instance to be started in the end of the image creation process.<br> |