BUG 11531 - update to build configuration items --DRAFT--
authorfturovic <frank.turovich@nokia.com>
Mon, 30 Aug 2010 16:44:20 -0500
changeset 1920 b6a66d85e102
parent 1919 5c9cbbdfb5c2
child 1921 3cb523bc5761
BUG 11531 - update to build configuration items --DRAFT--
core/com.nokia.carbide.cpp.doc.user/book.css
core/com.nokia.carbide.cpp.doc.user/html/reference/pref_carb_symbian_sdk.htm
core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/images/menu_build_config_select_tgt_01.png
core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/images/wnd_add_build_config_manager.png
core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_creating_sis_file.htm
core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_new_build_config.htm
core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_set_build_tgt.htm
core/com.nokia.carbide.cpp.doc.user/html/tasks/sdks/sdk_platform_filter.htm
core/com.nokia.carbide.cpp.doc.user/html/tasks/sdks/sdk_search.htm
core/com.nokia.carbide.cpp.doc.user/plugin.xml
--- a/core/com.nokia.carbide.cpp.doc.user/book.css	Mon Aug 30 16:39:11 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/book.css	Mon Aug 30 16:44:20 2010 -0500
@@ -12,7 +12,7 @@
 /* 20091007 added verdana and ariel to list to match SFO website fonts choices */
 body, p, table, li {
 	font-family: Verdana, Ariel, Helvetica, sans-serif;
-	font-size: 0.9em;
+	font-size: 1.0em;
 	font-weight: normal;
 }
 
--- a/core/com.nokia.carbide.cpp.doc.user/html/reference/pref_carb_symbian_sdk.htm	Mon Aug 30 16:39:11 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/reference/pref_carb_symbian_sdk.htm	Mon Aug 30 16:44:20 2010 -0500
@@ -15,13 +15,13 @@
 </head>
    <body>
 <h2>Symbian SDKs</h2>
-Use the <img src="../images/command_link.png" border="0" alt="" /> <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=com.nokia.carbide.cpp.sdk.ui.sdk_prefs_page)")'>
-Symbian SDK</a> page in the <b>Preferences</b> window to control which installed SDKs are available to projects during an import.  To
-	 access SDK preferences preference panel, select <b>Window &gt; Preferences &gt; Carbide.c++ &gt; Symbian SDKs</b>. 
-   <p class="note"><b>NOTE</b> There must be at least one recognized SDK installed before you can create a project.  If the SDK you have installed is not recognized, you may still be able to add it to the Discovered Symbian OS SDK list. See <a href="../tasks/start/carbide_requirements.htm">Carbide.c++ Requirements</a> for a list of supported SDKs. </p>
-   <p class="note"><b>NOTE</b> This panel serves as a <span class="code">devices.xml</span> file editor. The <span class="code">devices.xml</span> file stores information about the installed SDKs used for Symbian OS development.</p>
-
-	  <p align="center" class="Image"><img src="images/prefs_symbian_sdks.png" alt="Symbian SDKs preference panel" width="719" height="525"></p>
+<p>Use the <img src="../images/command_link.png" border="0" alt="" /> <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=com.nokia.carbide.cpp.sdk.ui.sdk_prefs_page)")'>
+   Symbian SDKs</a> page in the <b>Preferences</b> window to view which installed SDKs are available to projects during an import. If the SDK is properly configured for SBSv2 you may never need to view this preference panel.</p>
+<p>One thing to note is that Carbde.c++ no longer requires the <span class="code">devices.xml</span> file to recognize and use SDKs. Insteads it now caches this information for later use. If the SDK contains an entry for the <span class="code">devices.xml</span> Carbide will use it.</p>
+<p>To
+    access <strong>Symbian SDKs</strong> preferences preference panel, select <b>Window &gt; Preferences &gt; Carbide.c++ &gt; Symbian SDKs</b>. </p>
+<p class="note"><b>NOTE</b> There must be at least one recognized SDK installed before you can create a project.  If the SDK you have installed is not recognized, you may still be able to add it to the Discovered Symbian OS SDK list. See <a href="../tasks/start/carbide_requirements.htm">Carbide.c++ Requirements</a> for a list of supported SDKs. </p>
+   <p align="center" class="Image"><img src="images/prefs_symbian_sdks.png" alt="Symbian SDKs preference panel" width="719" height="525"></p>
      <p align="center" class="figure">Figure 1. Symbian SDKs preference panel </p>
    <table width="800" border="0" cellpadding="2" cellspacing="0">
    <tr valign="top"><th width="221" class="Cell">Name</th><th width="584" class="Cell">Function</th></tr>
@@ -46,7 +46,7 @@
      </tr>
          <tr valign="top">
            <td class="Cell"><p><b>Rescan All SDKs</b></p>           </td>
-           <td class="Cell"><p>Click to <a href="../tasks/sdks/sdk_search.htm">rescan</a>  the drive  for newly installed SDKs. The devices.xml file is scanned for SDKs and the list of available SDKs is updated if the devices.xml file has changed.</p>
+           <td class="Cell"><p>Click to <a href="../tasks/sdks/sdk_search.htm">rescan</a>  the drive  for newly installed SDKs. </p>
              <p class="note"><b>NOTE</b> Carbide.c++ scans for available SDKs each time it is started.</p></td>
         </tr>
    </table>
Binary file core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/images/menu_build_config_select_tgt_01.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/images/wnd_add_build_config_manager.png has changed
--- a/core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_creating_sis_file.htm	Mon Aug 30 16:39:11 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_creating_sis_file.htm	Mon Aug 30 16:44:20 2010 -0500
@@ -21,7 +21,7 @@
 <ul>
   <li>For non-Platform Security SDKs (pre-OS 9.x), <span class="code">makesis</span> is called</li>
 </ul>
-<p>Depending upon which tool is used, you will  need to complete some entries in the<a href="../../reference/build_properties/pane_build_config_sis.htm"> SIS Builder</a> pane of the Carbide Build Configurations window of the project Properties dialog box. You can access this pane by selecting a project in the Project Explorer view and select <b>Project &gt; Properties</b> &gt;  <b>Carbide Build Configurations</b>. Fill in the necessary information to add PKG files to the project for downloading. </p>
+<p>Depending upon which tool is used, you will  need to complete some entries in the<a href="../../reference/build_properties/pane_build_config_sis.htm"> SIS Builder</a> pane of the Carbide Build Configurations panel of the project Properties dialog box. You can access this pane by selecting a project in the Project Explorer view and select <b>Project &gt; Properties</b> &gt;  <b>Carbide Build Configurations</b>. Fill in the necessary information to add PKG files to the project for downloading. </p>
 <table width="88%"  border="0" cellpadding="2" cellspacing="0">
   <tr>
     <th width="19%" scope="col">Tool</th>
--- a/core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_new_build_config.htm	Mon Aug 30 16:39:11 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_new_build_config.htm	Mon Aug 30 16:44:20 2010 -0500
@@ -6,25 +6,60 @@
 <meta name="LASTUPDATED" content="06/17/05 11:09:43" />
 <title>Adding/Removing Build Configurations</title>
 <link rel="StyleSheet" href="../../../book.css" type="text/css"/>
+<style type="text/css">
+<!--
+.style1 {
+	color: #EE0000;
+	font-weight: bold;
+}
+-->
+</style>
 </head>
 <body >
 <h2>Adding/Removing Build Configurations</h2>
-<p>Use the <b>Properties for &lt;<em>project_name</em>&gt;</b> window to manage the active or build configurations associated with a project. In the <b>Active Configuration</b> group you can select which build configuration is current active as well as choose which build configurations appear in the Build Configurations sub-menu as choices. </p>
+<p>Use the <b>Add/Remove Carbide Build Configurations </b>dialog  to manage the build configurations associated with a project. The choices presented in this dialog are the result of installed <a href="../../reference/pref_carb_symbian_sdk.htm">Symbian SDKs</a> and the variant builds associated with them as chosen in the <a href="../sdks/sdk_platform_filter.htm">Configuration Filtering Preferences</a> panel.</p>
 <div class="step">
   <h4>Adding/Removing a Build Configuration </h4>
   <ol>
-    <li>Open Carbide Build Configuration panel in the project's Properties window
-      <p>Select the <b>Project &gt; Properties</b> menu item or right-click the project name in the <a href="../../reference/view_proj_explorer.htm">Project Explorer</a> view, then select <b>Properties</b>. The project <b>Properties for <em>&lt;project_name&gt;</em></b> window appears. Then select Carbide Build Configurations. </p>    
-      <p align="center"><img src="images/panel_active_config.png" width="801" height="350" alt=""/></p>
-      <p class="figure">Figure 1 - Active Configuration group in project Properties window </p></li>
-    <li>Click Manage... in the Active Configuration group (Figure 1)
-      <p>The <b>Add/Remove Carbide Build Configuration </b> window appears (Figure 2). Use the <b>Add/Remove Carbide Build Configuration</b> window to manage the build configurations that appear on the Build Configurations sub-menu for the current project. You can also  click the <b>Manage configurations for the current project</b> icon (<img src="images/icon_manage_project_configs.png" width="16" height="16" align="absmiddle">) on the toolbar to open this dialog. </p>
+    <li>With a project selected in the Project Explorer view choose one of the following to open the <strong>Add/Remove Carbide Build Configuration</strong> window:<br>
+        <br>
     </li>
-    </ol>
+      <table width="800" border="0" cellpadding="2" cellspacing="0">
+          <tr valign="top">
+              <th width="221" class="Cell"><div align="left">From the ...</div></th>
+              <th width="584" class="Cell"><div align="left">Do the following...</div></th>
+          </tr>
+          <tr valign="top">
+              <td class="Cell"><b>Menu bar</b></td>
+              <td class="Cell"> Click the <strong>Project &gt; Manage Configuration &gt; Manage...</strong> menu option.</td>
+          </tr>
+          <tr valign="top">
+              <td class="Cell"><b>Toolbar</b></td>
+              <td class="Cell">Click the <b>Manage configurations for the current project</b> icon (<img src="images/icon_manage_project_configs.png" alt="" width="16" height="16" align="absmiddle">) on the toolbar</td>
+          </tr>
+          <tr valign="top">
+              <td class="Cell"><b>Project</b></td>
+              <td class="Cell"><ol>
+                  <li>Right-click the project              
+                  <li>Select Properties</li>
+                  <li>Click Carbide.c++ &gt; Build Configurations in the properties list.</li>
+                  <li>Click Manage... in the Active Configuration section.</li>
+              </ol></td>
+          </tr>
+      </table>
+      <br>
+      <p>The <b>Add/Remove Carbide Build Configurations </b> window appears (Figure 1).</p>
+      <li>Select the build configurations used by the project
+          <p>Use the <b>Add/Remove Carbide Build Configuration</b> window to manage the build configurations for the current project. Checkmarked items appear in the build configuration list while unchecked items do not.</p>
+          <p>SDKs or build configurations shown in <span class="style1">RED</span> indicate a problem with that item. An error message is appended to the item to aid you in solving the problem.</p>
+      </li>
   <p align="center"><img src="images/wnd_add_build_config_manager.png" width="650" height="500" alt="" /></p>
-  <blockquote>
-      <p class="figure">Figure 2 - Window for managing build configurations</p>
-  </blockquote>
+  <p class="figure">Figure 1 - Window for managing build configurations<br>
+      </p>
+      <p>Click the <a href="../sdks/sdk_platform_filter.htm">Build Configuration Filtering Preferences</a> link to set which SDKs and configurations should appear in the dialog.</p>
+      <p>Click the <a href="../../reference/pref_carb_symbian_sdk.htm">Symbian SDK</a> link to open the <a href="../../reference/pref_carb_symbian_sdk.htm"></a> related preference panel.</p>
+      <li>Click OK to set the selected projects  build configurations.</li>
+    </ol>
 </div>
 <h5>Related concepts</h5>
 <ul>
--- a/core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_set_build_tgt.htm	Mon Aug 30 16:39:11 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/tasks/projects/prj_set_build_tgt.htm	Mon Aug 30 16:44:20 2010 -0500
@@ -31,7 +31,7 @@
       </ul>
     </li>
     <blockquote>
-      <p align="center" class="figure"><img src="images/menu_build_config_select_tgt_01.png" width="734" height="240" /><br />
+      <p align="center" class="figure"><img src="images/menu_build_config_select_tgt_01.png" width="921" height="276" /><br />
       Figure 2 - Build Configuration menu</p>
     </blockquote>
     <li>From the project's context menu 
--- a/core/com.nokia.carbide.cpp.doc.user/html/tasks/sdks/sdk_platform_filter.htm	Mon Aug 30 16:39:11 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/tasks/sdks/sdk_platform_filter.htm	Mon Aug 30 16:44:20 2010 -0500
@@ -11,7 +11,7 @@
 <body >
 <h2> Build Configuration Filtering </h2>
 <p> Use the <img src="../../images/command_link.png" border="0" alt="" /> <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=com.nokia.carbide.cpp.sdk.ui.sdk_platform_filter_page)")'>
-Build Configuration Filtering</a> preference panel in the <b>Preferences</b> window to select which platforms are visible when creating new projects or build configurations. </p>
+Build Configuration Filtering</a> preference panel in the <b>Preferences</b> window to select which platforms are visible when creating new projects or build configurations. The results of this preference panel are used to populate the </p>
 <h3>SBSv2 tab</h3>
 <p>Use the <strong>SBSv2</strong> tab to select  configurations for that build system. SBSv2 is the prefered build system for the most current SDKs.</p>
 <p align="center"><img src="images/wnd_sdk_platform_filter_sbsv2.png" alt="SBSv2 tab" width="719" height="646"></p>
@@ -24,20 +24,20 @@
     </tr>
     <tr>
         <td><b>Default Configurations</b></td>
-        <td><p>Select platform build targets to be displayed for OS 9.5 and later when creating new projects and build configurations. BSF&rsquo;s  are gone in SBSv2.&nbsp; All build  configurations (platform/target), including the built-in platforms (WISNCW,  ARMV5), are declared in xml files in the <span class="code">\sbs\lib\config</span> directory.</p>
-            </td>
+        <td><p>The result of a Raptor query (<span class="code">--query=aliases</span>) to show every supported aliases in every installed SDK. The aliases marked with a checkmark are available immediately as a selectable build configuration.</p>
+        </td>
     </tr>
     <tr>
         <td><strong>Product Variant Configurations</strong></td>
-        <td>Lists all the known variants created for the selected build configuration.</td>
+        <td>The result of the a Raptor query (<span class="code">--query=product</span>) to show the supported product variants available for the selected configuration. This list is not displayed if none of the installed SDKs support variant builds.</td>
     </tr>
     <tr>
         <td><strong>Rescan Default Configurations</strong></td>
-        <td>Click to rescan for sbs and build configurations in the installed SDKs.</td>
+        <td>Click to rescan for sbs and build configurations in all installed SDKs.</td>
     </tr>
     <tr>
         <td><strong>Add Variant</strong></td>
-        <td>Adds a variant build to the selected build configuration. SDK must support variant builds for this to work.</td>
+        <td>Opens the <strong>Add a custom product configuration</strong> dialog to create a variant build for the selected build configuration. The SDK must support variant builds for this to work.</td>
     </tr>
     <tr>
         <td><strong>Remove Variant</strong></td>
@@ -79,7 +79,7 @@
       </ul>    </td>
   </tr>
 </table>
-<p align="left" class="note"><strong>NOTE</strong> EKA1 platform configurations are no longer supported by Carbide.</p>
+<p align="left" class="note"><strong>NOTE</strong> EKA1 platform configurations are not supported by Carbide.</p>
 <h4>Related references </h4>
 <ul>
   <li><a href="../WorkingwithSDKs.html">Working with SDKs</a></li>
--- a/core/com.nokia.carbide.cpp.doc.user/html/tasks/sdks/sdk_search.htm	Mon Aug 30 16:39:11 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/tasks/sdks/sdk_search.htm	Mon Aug 30 16:44:20 2010 -0500
@@ -10,7 +10,7 @@
 <body >
 <h2>Searching for SDKs</h2>
 <p>  Use the <a href="../../reference/pref_carb_sdk_preference.html">Symbian SDKs panel</a> to search for installed Symbian OS SDKs.</p>
-<p align="center"><img src="../../images/SDKPreferences.png" width="740" height="546" /></p>
+<p align="center"><img src="../../images/SDKPreferences.png" width="696" height="583" /></p>
 <p class="figure">Figure 1. Symbian SDKs panel</p>
 <div class="step">
   <h4>Searching for SDKs </h4>
--- a/core/com.nokia.carbide.cpp.doc.user/plugin.xml	Mon Aug 30 16:39:11 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/plugin.xml	Mon Aug 30 16:44:20 2010 -0500
@@ -47,13 +47,6 @@
 		 <cheatsheet
            composite="false"
 		   category="com.nokia.carbide.how_to.cheatsheets"
-           contentFile="html/cheatsheets/how_to_find_n_add_extensions.xml"
-           id="com.nokia.carbide.cpp.doc.user.add_extensions"
-           name="Find and Add Extensions"/>
-
-		 <cheatsheet
-           composite="false"
-		   category="com.nokia.carbide.how_to.cheatsheets"
            contentFile="html/cheatsheets/how_to_customize_code_styles.xml"
            id="com.nokia.carbide.cpp.doc.user.customize_code_styles"
            name="Customize Code Styles"/>
@@ -86,6 +79,13 @@
            id="com.nokia.carbide.cpp.doc.user.customize_export_settings"
            name="Share my Settings..."/>
 
+		 <cheatsheet
+           composite="false"
+		   category="com.nokia.carbide.how_to.cheatsheets"
+           contentFile="html/cheatsheets/how_to_find_n_add_extensions.xml"
+           id="com.nokia.carbide.cpp.doc.user.add_extensions"
+           name="Find and Add Extensions"/>
+
    </extension>
 
    <extension
@@ -119,15 +119,31 @@
             id="com.nokia.carbide.cpp.doc.user.stop_mode"
             name="Stop Mode On-Device Debugging" />
 			
-          <cheatsheet
-            category="com.nokia.carbide.ide.cheatsheets"
-            composite="false"
-            contentFile="$nl$/html/cheatsheets/getStarted_cs.xml"
-            id="com.nokia.carbide.cpp.doc.user.cheatsheet1176819414"
-             name="Creating and debugging an application project" />
-
    </extension>
 
+   <extension
+         point="org.eclipse.ui.cheatsheets.cheatSheetContent">
+         
+         <!-- CREATE A PLATSIM CATEGORY -->
+		<category
+			id="com.nokia.platsim.cheatsheets"
+			name="PlatSim" />
+            
+         <!-- ADD PLATSIM TOPICS TO CATEGORY -->
+		<cheatsheet
+			category="com.nokia.platsim.cheatsheets"
+			contentFile="html/cheatsheets/platsim_create_images.xml"
+			id="com.nokia.platsim.platsim_create_images"
+			name="Creating images in PlatSim" />
+			
+		<cheatsheet
+			category="com.nokia.platsim.cheatsheets"
+			contentFile="html/cheatsheets/platsim_debugging.xml"
+			id="com.nokia.platsim.platsim_debugging"
+			name="PlatSim debugging in Carbide.c++" />
+			
+   </extension>
+   
 	<!--
    <extension
          point="org.eclipse.ui.cheatsheets.cheatSheetContent">