add documentation and hook up tray dialog for abld deps tracking query (bug 9227)
authortimkelly
Tue, 30 Jun 2009 10:50:18 -0500
changeset 323 d40e42540f1f
parent 322 4c93a2b1f481
child 328 31403302c38e
add documentation and hook up tray dialog for abld deps tracking query (bug 9227)
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/ui/CarbideCPPBuilderUIHelpIds.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/ui/TrackDependenciesQueryDialog.java
core/com.nokia.carbide.cpp.doc.user/html/concepts/dependency_tracking.htm
core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml
core/com.nokia.carbide.cpp.doc.user/html/reference/wnd_build_prefs.htm
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/ui/CarbideCPPBuilderUIHelpIds.java	Tue Jun 30 10:49:24 2009 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/ui/CarbideCPPBuilderUIHelpIds.java	Tue Jun 30 10:50:18 2009 -0500
@@ -32,4 +32,5 @@
 	public static final String CARBIDE_BUILDER_SIS_DIALOG = CarbideBuilderPlugin.PLUGIN_ID + ".builder_sis_dialog"; //$NON-NLS-1$
 	public static final String CARBIDE_BUILDER_MMP_CHANGED_ACTION_DIALOG = CarbideBuilderPlugin.PLUGIN_ID + ".builder_mmp_changed_action_dialog"; //$NON-NLS-1$
 	public static final String CARBIDE_BUILDER_MMP_SELECTION_DIALOG = CarbideBuilderPlugin.PLUGIN_ID + ".builder_mmp_selection_dialog"; //$NON-NLS-1$
+	public static final String CARBIDE_BUILDER_TRACK_DEPENDENCIES_QUERY_DIALOG = CarbideBuilderPlugin.PLUGIN_ID + ".dependency_tracking_dialog"; //$NON-NLS-1$
 }
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/ui/TrackDependenciesQueryDialog.java	Tue Jun 30 10:49:24 2009 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/ui/TrackDependenciesQueryDialog.java	Tue Jun 30 10:50:18 2009 -0500
@@ -25,6 +25,7 @@
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.*;
+import org.eclipse.ui.PlatformUI;
 
 import com.nokia.carbide.cdt.builder.BuilderPreferenceConstants;
 import com.nokia.carbide.cdt.builder.CarbideBuilderPlugin;
@@ -57,6 +58,7 @@
 	public TrackDependenciesQueryDialog(Shell shell, ICarbideProjectInfo cpi) {
 		super(shell);
 		this.cpi = cpi;
+		setShellStyle(getShellStyle() | SWT.RESIZE);
 	}
 
 	/**
@@ -113,6 +115,7 @@
 	 */
 	protected void configureShell(Shell shell) {
 		super.configureShell(shell);
+		PlatformUI.getWorkbench().getHelpSystem().setHelp(shell, CarbideCPPBuilderUIHelpIds.CARBIDE_BUILDER_TRACK_DEPENDENCIES_QUERY_DIALOG);
 		shell.setText("Project rebuild notification"); //$NON-NLS-1$
 	}
 
--- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/dependency_tracking.htm	Tue Jun 30 10:49:24 2009 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/dependency_tracking.htm	Tue Jun 30 10:50:18 2009 -0500
@@ -1,22 +1,31 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-<html>
-<head>
-<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>Dependency Tracking</title>
-<link rel="StyleSheet" href="../../book.css" type="text/css"/>
-</head>
-<body bgcolor="#FFFFFF">
-<h2>Dependency Tracking</h2>
-<p> blah blah blah</p>
-<p align="center">&nbsp;</p>
-<p align="left" class="figure">Figure 1 -Dependency Tracking dialog</p>
-<h5>Related references <b></b></h5>
-<ul>
-  <li>???</li>
-</ul>
-<div id="footer">Copyright &copy; 2009 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>
-</html>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+<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>Dependency Tracking</title>
+<link rel="StyleSheet" href="../../book.css" type="text/css"/>
+<style type="text/css">
+<!--
+.style1 {font-family: "Courier New", Courier, mono}
+-->
+</style>
+</head>
+<body bgcolor="#FFFFFF">
+<h2>Dependency Tracking</h2>
+<p> This section only applies to the SBSv1 (abld) build system. If you are using the Raptor (SBSv2) build system Carbide does not perform any build system modifications to optimize dependency tracking.</p>
+<p>Carbide has made some performance improvements over command-line builds when performing incremental builds. Once a project has been built, many users will invoke 'abld build' on their project, not knowing that their makefiles will be regenerated each time, taking a large performance hit. Although a command-line user can invoke 'abld target' to improve incremental build performance, Carbide invokes each build stage independently for a full incremental build (including the 'abld makefile' stage). In order to get around this performance hit from the IDE, Carbide manages the source and resource dependencies in separate <span class="style1">.d</span> (dependency) files generated under the build system. Then Carbide  makes a small modification to each component's (MMP) makefile under the <span class="style1">\epoc32\build</span>\ directory by including the generated .d files as dependency includes. This performance modification  makes incremental builds faster from Carbide.</p>
+<p>Normally,  you do not need to know the details dependency management unless you first build from the command-line and then try to build their project from the IDE. When this happens, Carbide will prompt you with the following dialog when you initiate a build from the IDE.</p>
+<p align="center"><img src="images/deps_track_query.png" width="483" height="203"></p>
+<p align="left" class="figure">Figure 1 -Dependency Tracking dialog</p>
+<p>If you plan to continue building in Carbide it is recommended you choose the option to <strong>Improve Carbide build times</strong>. However, be cautious of this as Carbide will remove all the object code and build everything from scratch. If you do choose the option <strong>Do not update dependencies</strong>, then Carbide will disable the option to manage dependencies under the <strong>Carbide Project Settings</strong>, <strong>SBSv1</strong> tab. </p>
+<h5>Related references <b></b></h5>
+<ul>
+  <li><a href="../reference/build_properties/pane_project_settings.htm">Carbide Project Settings</a></li>
+  <li><a href="../reference/wnd_build_prefs.htm">Carbide Global Build Settings</a> </li>
+</ul>
+<div id="footer">Copyright &copy; 2009 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>
+</html>
--- a/core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml	Tue Jun 30 10:49:24 2009 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml	Tue Jun 30 10:50:18 2009 -0500
@@ -76,10 +76,8 @@
 	<!-- Dependency Tracking (added v2.1) -->
 	<context id="dependency_tracking_dialog" >
 		<description>Managing makefile dependencies</description>
-		<topic label="Dependency Tracking"	   		href="html/concepts/dependency_tracking.htm" />
+		<topic label="Dependency Tracking"		href="html/concepts/dependency_tracking.htm" />
 	</context>
-
-	
 	
 <!-- =============================================================================== -->
 <!-- PLUGIN: com.nokia.carbide.cdt.rombuilder                                        -->
--- a/core/com.nokia.carbide.cpp.doc.user/html/reference/wnd_build_prefs.htm	Tue Jun 30 10:49:24 2009 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/reference/wnd_build_prefs.htm	Tue Jun 30 10:50:18 2009 -0500
@@ -90,6 +90,10 @@
       </ul>
     </td>
   </tr>
+  <tr>
+    <td><strong>Do not offer to track dependencies for projects build on command-line </strong></td>
+    <td>If you build a project from the command-line (with 'abld build') and then import the project into Carbide and attempt to build, Carbide will prompt you if you would like Carbide to manage source dependencies for you. Enabling this option insures Carbide will not ask you to manage dependencies (they will be done as normally done via 'abld build' command).</td>
+  </tr>
 </table>
 <p align="left">&nbsp;</p>
 <p align="center"><img src="images/carbide_proj_settings_sbsv2.png" alt="sbsv2 tab" width="420" height="283"></p>