minor edits and updated images
authorfturovic <frank.turovich@nokia.com>
Wed, 16 Jun 2010 11:39:35 -0500
changeset 1475 fb0e02cb252b
parent 1473 6c45b7c9cdac
child 1481 c7f22cc57d44
minor edits and updated images
core/com.nokia.carbide.cpp.doc.user/html/concepts/CarbidePerspective.html
core/com.nokia.carbide.cpp.doc.user/html/concepts/cvs.htm
core/com.nokia.carbide.cpp.doc.user/html/concepts/ext_build_support.htm
core/com.nokia.carbide.cpp.doc.user/html/concepts/images/wnd_workspace_launcher.png
core/com.nokia.carbide.cpp.doc.user/html/concepts/images/workbench.png
core/com.nokia.carbide.cpp.doc.user/html/concepts/ngage_projects.htm
core/com.nokia.carbide.cpp.doc.user/html/concepts/templates.htm
core/com.nokia.carbide.cpp.doc.user/html/concepts/tour.html
core/com.nokia.carbide.cpp.doc.user/html/concepts/workspaces.htm
core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml
core/com.nokia.carbide.cpp.doc.user/html/images/views/perspective_debug.png
core/com.nokia.carbide.cpp.doc.user/html/reference/perspective_debug.htm
core/com.nokia.carbide.cpp.doc.user/plugin.xml
core/com.nokia.carbide.cpp.doc.user/tocCarbide.xml
--- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/CarbidePerspective.html	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/CarbidePerspective.html	Wed Jun 16 11:39:35 2010 -0500
@@ -21,7 +21,7 @@
         <li><a href="../reference/view_executables.htm">Executables</a> view - provides a dynamic list of executables and their related source files</li>
 	    <li><a href="../reference/trk/view_remote_connection.htm">Remote Connections</a> view &ndash; use to monitor, create, edit, or remove  common  connection settings</li>
 	 </ul>
-     <p align="center"><img src="images/workbench.png" width="1052" height="800" /></p>
+     <p align="center"><img src="images/workbench.png" width="1028" height="789" /></p>
    <p class="figure">Figure 1 - Carbide C/C++ perspective </p>
 	 <p class="note"><b>NOTE</b> Click the <img src="../images/icons/double_arrow_icon.png" width="12" height="9" align="absmiddle" /> icon to show additional options that may not be visible in the perspective view.</p>
 	 <p>For more information on perspectives see <b>Workbench User Guide &gt; Concepts &gt; <a href="PLUGINS_ROOT/org.eclipse.platform.doc.user/concepts/concepts-4.htm">Perspectives</a></b>, and for views see  <b>C/C++ Development User Guide &gt; Reference
--- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/cvs.htm	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/cvs.htm	Wed Jun 16 11:39:35 2010 -0500
@@ -4,13 +4,21 @@
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
 <meta http-equiv="Content-Style-Type" content="text/css" />
 <meta name="LASTUPDATED" content="06/17/05 11:09:43" />
-<title>Concurrent Versions System (CVS)</title>
+<title>Software Configuration Management</title>
 <link rel="StyleSheet" href="../../book.css" type="text/css"/>
 </head>
 <body bgcolor="#FFFFFF">
-<h2>Concurrent Versions System (CVS) </h2>
-<p>Carbide.c++ supports the Concurrent Versions System (<a href="http://www.nongnu.org/cvs/">CVS</a>) for immediate version control support. Other revision systems are also supported but require the downloading of an Eclipse plug-in to add that feature to Carbide. Visit the <a href="http://www.eclipse.org">eclipse.org</a> or <a href="http://eclipse-plugins.2y.net">eclipse-plugins.2y.net</a> sites to locate the  plug-ins you need. </p>
-<p>For more informaton on using CVS within Carbide, see the <b>Workbench User Guide &gt; Concepts &gt; Team programming with CVS</b>.</p>
+<h2>Software Configuration Management (SCM) </h2>
+<p>The <strong>Carbide.c++</strong> tools are built on top of the <strong>Eclipse</strong> and <strong>CDT</strong> open source projects (<a href="http://www.eclipse.org">eclipse.org</a>). Carbide can use several popular <a href="http://en.wikipedia.org/wiki/Software_configuration_management">software configuration management</a> systems including:</p>
+<ul>
+    <li><a href="http://en.wikipedia.org/wiki/Apache_Subversion">Apache Subversive</a></li>
+    <li><a href="tp://www.nongnu.org/cvs/">CVS</a> (<em>plug-in included with Carbide</em>)</li>
+    <li><a href="http://en.wikipedia.org/wiki/Git_(software)">Git</a></li>
+    <li><a href="http://en.wikipedia.org/wiki/Clearcase">IBM Rational Clearcase</a></li>
+    <li><a href="http://en.wikipedia.org/wiki/Mercurial">Mercurial</a></li>
+    <li><a href="http://en.wikipedia.org/wiki/Perforce">Perforce</a></li>
+</ul>
+<p>Other revision systems are also supported but require the downloading of an Eclipse plug-in to add that capability to Carbide. Visit the <a href="http://eclipse-plugins.2y.net">eclipse-plugins.2y.net</a> sites to locate the  plug-ins you need. </p>
 <div class="step">
   <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>
 
--- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/ext_build_support.htm	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/ext_build_support.htm	Wed Jun 16 11:39:35 2010 -0500
@@ -9,7 +9,7 @@
 </head>
 <body bgcolor="#FFFFFF">
 <h2>External Builds Support</h2>
-<p>  The IDE will perform the following tasks on external makefiles:</p>
+<p>  The Carbide IDE  performs the following tasks on external makefiles:</p>
 <ul>
   <li>Build</li>
   <li>Debug</li>
@@ -17,10 +17,10 @@
   <li>Source Browsing</li>
   <li>Error Lookup</li>
 </ul>
-<p>The IDE can build an external makefile and debug its output. A linker plugin will enable the IDE to manage a command line and targets associated with a makefile. The command line is executed when a build step is initiated. The linker plugin will also supply the executable to use for debugging.</p>
-<p>The linker plugin will provide a preference panel named External Build that is used to configure a target. The preference panel provides text fields for you to configure the command line for the target (which will enable building), specify the working directory and the output file used to launch a debugging session, and the debug platform.</p>
+<p>Carbide can build an external makefile and debug its output. A linker plugin  enables Carbide to manage a command line and targets associated with a makefile. The command line is executed when a build step is initiated. The linker plugin will also supply the executable to use for debugging.</p>
+<p>The linker plugin  provides a preference panel named <strong>External Build</strong> that is used to configure a target. The preference panel provides text fields for you to configure the command line for the target (which will enable building), specify the working directory and the output file used to launch a debugging session, and the debug platform.</p>
 <p>The linker plugin is generic so that it can be used regardless of the target CPU and OS. The list of available debugger preference panels will be updated by the IDE when you select the debug platform.</p>
-<p>The External Build Target preference panel will collect the following information:</p>
+<p>The <strong>External Build Target</strong> preference panel  collects the following information:</p>
 <ul>
   <li>Build command line to be executed in the build step</li>
 </ul>
@@ -38,12 +38,12 @@
   <p>If multiple build steps are performed on the same target, the output from each build step will be appended to the build output window. Each block of output will be separated by &ldquo;----Build started----&rdquo; and &ldquo;----Done----&rdquo; tags.</p>
   <p>The build output window will allow users to navigate directly to the location of a compilation error. Double-click a line that contains an error message or press Enter when the cursor is in the line. If the IDE determines that a valid error message exists on the selected line, the source file is opened to the line on which the error occurred.</p>
   <p>Click the right mouse button in the build output window to display a context menu.</p>
+  <ul>
+      <li>The <strong>Copy</strong> command  copies selected text to the clipboard. If no text is selected then the line that contains the cursor is copied.</li>
+      <li>The <strong>Clear All</strong> command  clears the contents of output window.</li>
+      <li>The <strong>Go To Error</strong> command  navigates to the error location. This is identical to double-clicking.</li>
+  </ul>
 </blockquote>
-<ul>
-  <li>The Copy command will copy selected text to the clipboard. If no text is selected then the line that contains the cursor will be copied.</li>
-  <li>The Clear All command will clear contents of output window.</li>
-  <li>The Go To Error command will navigate to the error location. This is identical to double-clicking.</li>
-</ul>
 <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>
 
 </body>
Binary file core/com.nokia.carbide.cpp.doc.user/html/concepts/images/wnd_workspace_launcher.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/concepts/images/workbench.png has changed
--- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/ngage_projects.htm	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/ngage_projects.htm	Wed Jun 16 11:39:35 2010 -0500
@@ -17,12 +17,12 @@
   <li>Install the N-Gage SDK on your PC</li>
   <li>Place your game project inside the N-Gage SDK</li>
   <li> In Carbide.c++, click<b> File &gt; <a href="../tasks/ImportingProjects.html">Import</a></b></li>
-  <li>Select <b>Symbian OS Bld.inf</b> importer and navigate to your bld.inf  file to import it </li>
+  <li>Select <b>Symbian OS Bld.inf</b> <strong>File</strong> importer and navigate to your <span class="code">bld.inf</span>  file to import it </li>
 </ol>
 <h4>Building the N-Gage project</h4>
 <p>Once the game project has been imported, use these steps to create an N-GAGE game file:</p>
 <ol>
-  <li>Right-click the project and choose <b>Properties</b> to open the <b>Properties for <i>project_name</i></b> window  </li>
+  <li>Right-click the project name and choose <b>Properties</b> to open the <b>Properties for <i>project_name</i></b> window  </li>
   <li>In the <b>Carbide.c++ &gt; Carbide Build Configuration &gt; <a href="../reference/build_properties/pane_build_config_sis.htm">SIS Builder</a></b> panel, click <b>Add</b>.</li>
   <li>In the <b><a href="../reference/build_properties/wnd_sis_properties.htm">SIS Properties</a></b> window:
     <ol>
@@ -67,10 +67,10 @@
 <h4>Debugging the Game project</h4>
 <p>With your game file installed on the device, create a launch configuration for the project. In Carbide:</p>
 <ol>
-  <li>Open<span class="note"><b>Window &gt; Preferences &gt; Run/Debug &gt;<img src="../images/command_link.png" width="16" height="12"> <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.debug.ui.LaunchingPreferencePage)")'> Launching</a></b> preference panel </span>and disable the <b>Build (if required) before launching</b> option</li>
-  <li>Right-click the project and choose <b>Debug As &gt; Debug As</b> to open the <b><a href="../reference/wnd_debug_configuration.htm">Debug</a></b> window</li>
-  <li><a href="../tasks/projects/prj_debug_config.htm">Create</a> an <b>Application TRK</b> launch configuration
-    <ul>
+  <li>Open <span class="note"><b>Window &gt; Preferences &gt; Run/Debug &gt;<img src="../images/command_link.png" width="16" height="12"> <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.debug.ui.LaunchingPreferencePage)")'> Launching</a></b> preference panel </span>and disable the <b>Build (if required) before launching</b> option under the General Options group</li>
+  <li>Right-click the project and choose <b>Debug As &gt; Debug Configuration</b> to open the <b><a href="../reference/wnd_debug_configuration.htm">Debug Cinfigurations</a></b> window</li>
+  <li><a href="../tasks/projects/prj_debug_config.htm">Create</a> an <b>Symbian OS Application TRK</b> launch configuration
+      <ul>
       <li>In the <b><a href="../projects/launch/page_connection.htm">Connection</a></b> tab select the COM port used to connect to the device. </li>
       <li> In the <b><a href="../projects/launch/page_installation.htm">Installation</a></b> tab, verify that the game SISX file is correct </li>
       <li>In the <b><a href="../projects/launch/page_debugger.htm">Debug</a></b> tab, enable the View messges between PC and debug agent on the phone if you want to monitor communications between TRK and Carbide </li>
@@ -82,13 +82,13 @@
 <p>The Debugger launches the game project in the device and halts when it encounters the breakpoint you set. </p>
 <h3>For Emulator Debugging </h3>
 <h4>Deploying and debugging the N-Gage project on an emulator</h4>
-<p>With your game file installed to the emulator, create a launch configuration for the project. In Carbide:</p>
+<p>With your game file installed on the emulator, create a launch configuration for the project. In Carbide:</p>
 <ol>
-  <li>Open <b>Window &gt; Preferences &gt;   Run/Debug &gt; Launching</b> and disable the <b>Build (if required) before launching</b> option</li>
-  <li>Right-click the project and choose <b>Debug As &gt; Debug As</b> to open the <b>Debug</b> window</li>
+  <li>Open <b>Window &gt; Preferences &gt;   Run/Debug &gt; Launching</b> and disable the <b>Build (if required) before launching</b> option under the General Options group</li>
+  <li>Right-click the project and choose <b>Debug As &gt; Debug Configurations</b> to open the <b>Debug Configurations</b> window</li>
   <li>Create an <b>Symbian OS Emulation </b> launch configuration</li>
   <li>Click <b>Debug</b> to launch the emulator </li>
-  <li>In the emulator, select <b>File &gt; Open</b>,  locate and select the .N-GAGE installation file and click <b>Open</b> to install the project </li>
+  <li>In the emulator, select <b>File &gt; Open</b>,  locate and select the <span class="code">.N-GAGE</span> installation file and click <b>Open</b> to install the project </li>
   <li>Open the Installation folder, launch the N-Gage runtime application</li>
   <li>In the N-Gage runtime launch the game  </li>
   <li>If any breakpoint is hit in the game project, the debugger suspends</li>
--- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/templates.htm	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/templates.htm	Wed Jun 16 11:39:35 2010 -0500
@@ -29,9 +29,8 @@
     <td><b>S60 </b></td>
     <td><ul>
       <li> GUI Application</li>
-      <li> GUI Application with UI Designer</li>
-      <li>Open C Console application - project template based on  industry-standard POSIX and middleware C libraries for S60 </li>
-    </ul></td>
+      <li> Open C Console application - project template based on  industry-standard POSIX and middleware C libraries for S60 </li>
+      </ul></td>
   </tr>
   <tr>
     <td><b>Tutorials</b></td>
--- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/tour.html	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/tour.html	Wed Jun 16 11:39:35 2010 -0500
@@ -20,7 +20,7 @@
 		something like this:</p> 
      <div class="Figure">
 
-	 <p class="Image"><img src="images/workbench.png" width="815" height="638" /></p>
+	 <p class="Image"><img src="images/workbench.png" width="1028" height="789" /></p>
  
 	 
 </div> 
--- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/workspaces.htm	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/workspaces.htm	Wed Jun 16 11:39:35 2010 -0500
@@ -18,7 +18,9 @@
 <body bgcolor="#FFFFFF">
 <h2>Workspace Information </h2>
 <p>A workspace is the default place to store and create resources like projects, folders, and files. These are then presented to the user in a perspective which enables the presentation and manipulation of the stored resources.</p>
-<p> When Carbide is launched it asks for a workspace to open. As you can have multiple workspaces, all independent from each other, choosing the workspace containing the projects to work on is important. Projects within a workspace are  shown in the Carbide workbench within the <a href="PLUGINS_ROOT/org.eclipse.platform.doc.user/concepts/cnav.htm">Project Explorer</a> and <a href="../reference/view_cpp_projects.htm">C/C++ Project</a> views. When you create a new project it is automatically added to the currently open workspace. You can import existing projects into a workspace from INF files.</p>
+<p>When Carbide is launched it asks for a workspace to open (Figure 1). As you can have multiple workspaces, all independent from each other, choosing the workspace containing the projects to work on is important. Projects within a workspace are  shown in the Carbide workbench within the <a href="PLUGINS_ROOT/org.eclipse.platform.doc.user/concepts/cnav.htm">Project Explorer</a> and <a href="../reference/view_cpp_projects.htm">C/C++ Project</a> views. When you create a new project it is automatically added to the currently open workspace. You can import existing projects into a workspace from INF files.</p>
+<p align="center"><img src="images/wnd_workspace_launcher.png" alt="Workspace Launcher dialog" width="630" height="291"></p>
+<p class="figure">Figure 1. Workspace Launcher dialog</p>
 <p class="note"><span class="style1">WARNING</span> Bld.inf imported projects are not copied, so do not delete the contents when deleting the project.</p>
 <p>Projects in one workspace cannot refer to projects in a different workspace. Thus, large projects spanning  folders outside of the workspace are not handled at all. Storing all the project files in the workspace makes managing them   easier from a project management perspective. Files accessible inside the workspace, like project source and resource files, are better supported than those outside the workspace (for example, SDK headers). Local History, CVS, MMP/bld.inf editors, etc. are available for files inside the workspace but not for those outside the workspace. </p>
 <p class="note"><b>NOTE</b> Carbide automatically updates MMP and INF files as changes are made within the MMP and INF editors.</p>
--- a/core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml	Wed Jun 16 11:39:35 2010 -0500
@@ -6,7 +6,6 @@
 <!-- Includes context help references for:                                           -->
 <!--    plugin="com.nokia.carbide.cdt.builder"                                       -->
 <!--    plugin="com.nokia.carbide.cdt.rombuilder"                                    -->
-<!--    plugin="com.nokia.carbide.cpp.leavescan"                                     -->
 <!--    plugin="com.nokia.carbide.cpp.project.ui"                                    -->
 <!--    plugin="com.nokia.carbide.cpp.sdk.ui"                                        -->
 <!--    plugin="com.nokia.carbide.remoteConnections"                                 -->
@@ -98,17 +97,6 @@
 	
 	
 <!-- =============================================================================== -->
-<!-- PLUGIN: com.nokia.carbide.cpp.leavescan                                         -->
-<!-- =============================================================================== -->
-	
-	<!-- LEAVESCAN PREF PANEL -->
-	<context id="leavescan_prefs_page" >
-		<description>Specify the Leavescan directory.</description>
-		<topic label="Leavescan Preferences" 	href="html/reference/leavescan_pref.html"/>
-	</context>
-	
-	
-<!-- =============================================================================== -->
 <!-- PLUGIN: com.nokia.carbide.cpp.project.ui                                        -->
 <!-- =============================================================================== -->
 
Binary file core/com.nokia.carbide.cpp.doc.user/html/images/views/perspective_debug.png has changed
--- a/core/com.nokia.carbide.cpp.doc.user/html/reference/perspective_debug.htm	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/reference/perspective_debug.htm	Wed Jun 16 11:39:35 2010 -0500
@@ -32,7 +32,7 @@
   <li><a href="PLUGINS_ROOT/org.eclipse.cdt.doc.user/reference/cdt_u_modules_view.htm">Modules</a> view - uses the <a href="../projects/launch/wiz_new_launch_config.htm">Symbolics Loading</a> option to show modules loaded during a debug session </li>
   <li><a href="view_registers.htm">Registers</a> view - shows general, FPU, or host-specific registers of the host computer or target device</li>
 </ul>
-<p align="center"><img src="../images/views/perspective_debug.png" width="830" height="704" alt="" /></p>
+<p align="center"><img src="../images/views/perspective_debug.png" width="1028" height="789" alt="" /></p>
 <p class="figure">Figure 1. Debug perspective used by Carbide.c++</p>
 <p class="note"><b>NOTE</b> Click the <img src="../images/icons/double_arrow_icon.png" width="12" height="9" valign="absmiddle" alt="" /> icon to show additional options that may not be visible in the perspective view.</p>
 <p>For more information on perspectives see <b>Workbench User Guide &gt; Concepts &gt; <a href="PLUGINS_ROOT/org.eclipse.platform.doc.user/concepts/concepts-4.htm">Perspectives</a></b>, and for views see <b>C/C++ Development User Guide &gt; Reference
--- a/core/com.nokia.carbide.cpp.doc.user/plugin.xml	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/plugin.xml	Wed Jun 16 11:39:35 2010 -0500
@@ -140,9 +140,6 @@
        <contexts file="html/context_help/carbide_ide_dialogs_help.xml"
        		plugin="com.nokia.carbide.cpp.builder.utils" />
 
-       <contexts file="html/context_help/carbide_ide_dialogs_help.xml"
-       		plugin="com.nokia.carbide.cpp.leavescan" />
-
        <!-- SPN VIEW, INF IMPORTER, MMP, MBM, AIF editors, and miscellaneous HELP  -->
        <contexts file="html/context_help/carbide_ide_dialogs_help.xml"
        		plugin="com.nokia.carbide.cpp.project.ui" />
--- a/core/com.nokia.carbide.cpp.doc.user/tocCarbide.xml	Tue Jun 15 16:19:30 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/tocCarbide.xml	Wed Jun 16 11:39:35 2010 -0500
@@ -69,7 +69,6 @@
       <topic label="Build"							href="html/reference/wnd_build_prefs.htm" />
       <topic label="Carbide.c++ News"					href="html/reference/prefs_carbide_news.htm" />
       <topic label="Debugger"							href="html/reference/wnd_debugger_prefs.htm" />
-      <topic label="CodeScanner"	  					href="PLUGINS_ROOT/com.nokia.carbide.cpp.codescanner/html/pref_codescanner_01.htm" />
       <topic label="Diagnostic Logs"          		href="html/reference/wnd_diagnostic_logs_pref.htm" />
       <topic label="Performance Investigator"  		href="PLUGINS_ROOT/com.nokia.carbide.cpp.pi.doc.user/html/tasks/analyser/key_profile_pref.htm" />
       <topic label="Platform Filtering Preferences"	href="html/tasks/sdks/sdk_platform_filter.htm" />
@@ -198,6 +197,7 @@
       <topic label="Qt preference panel"				href="html/qt_help/qt_pref_panel.htm" />
       <topic label="Qt project properties"			href="html/qt_help/qt_project_properties.htm" />
     </topic>
+    <topic label="Software Configuration Management"	href="html/concepts/cvs.htm" />
   </topic>
   <topic label="Debugging projects" 				href="html/concepts/debugger_about.htm" >
     <topic label="Running a program" 			href="html/debugger/debug/cmds_starting.htm" />