Bug 312167 - Revised Environment and Discover Options property panels

author: L. Frank Turovich 2010-05-08 21:15:37 +0000
committer: L. Frank Turovich 2010-05-08 21:15:37 +0000
commit: ef4a520f87092163b16da1a5ae1db73de98e0e48 (patch)
tree: 6011e5be5c8114019a7ee82be8bafcd68fc73cd5 /doc/org.eclipse.cdt.doc.user
parent: 6c9fbdda2e2e538e9659f0284b635699ca19681c (diff)
download: org.eclipse.cdt-ef4a520f87092163b16da1a5ae1db73de98e0e48.tar.gz
org.eclipse.cdt-ef4a520f87092163b16da1a5ae1db73de98e0e48.tar.xz
org.eclipse.cdt-ef4a520f87092163b16da1a5ae1db73de98e0e48.zip
5 files changed, 61 insertions, 48 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_buildenv_newenvvar.png b/doc/org.eclipse.cdt.doc.user/images/cdt_buildenv_newenvvar.png
index 725b357012f..0bec0a2f6af 100644
--- a/doc/org.eclipse.cdt.doc.user/images/cdt_buildenv_newenvvar.png
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_buildenv_newenvvar.png
diff --git a/doc/org.eclipse.cdt.doc.user/images/mpref_discovopts.png b/doc/org.eclipse.cdt.doc.user/images/mpref_discovopts.png
index fe0c566f191..caf74ec2129 100644
--- a/doc/org.eclipse.cdt.doc.user/images/mpref_discovopts.png
+++ b/doc/org.eclipse.cdt.doc.user/images/mpref_discovopts.png
diff --git a/doc/org.eclipse.cdt.doc.user/images/prop_environment.png b/doc/org.eclipse.cdt.doc.user/images/prop_environment.png
index e303316ae29..86d4672794e 100644
--- a/doc/org.eclipse.cdt.doc.user/images/prop_environment.png
+++ b/doc/org.eclipse.cdt.doc.user/images/prop_environment.png
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_prop_build_discovery.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_prop_build_discovery.htm
index b5a0040ace9..a4e6b10e40d 100644
--- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_prop_build_discovery.htm
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_prop_build_discovery.htm
@@ -8,30 +8,31 @@
 </head>
 <body>
 
-<h1>Discovery options preferences </h1>
-<br>
-<p style="margin-top: 0">Controls how to discover information required to build your project, enhance search and Content Assist functionality, and automatically enhance your makefile, such as include paths and symbol definitions.</p>
-<p style="margin-top: 0"><img src="../images/mpref_discovopts.png" width="801" height="676" alt="Discovery options preference page"></p>
+<h1>Discovery Options properties </h1>
+<p>Use the <strong>Discovery Options</strong> properties panel to control how information required to build your project is discovered, enhance search and Content Assist functionality, and automatically enhance your makefile, such as include paths and symbol definitions.</p>
+<p><img src="../images/mpref_discovopts.png" alt="Discovery options preference page"></p>
 
-<table cellpadding="5" cellspacing="0" border="1" >
-	<br>
-		<caption><strong>Discovery options preferences</strong></caption>
-	<br>	
+<table cellpadding="5" cellspacing="0" border="1" width="700px" bordercolor="#DDDDDD" >
+	<caption><strong>Discovery Options preferences</strong></caption>	
 	<colgroup>
 		<col width="30%" valign="top" >
 		<col width="70%" valign="top" >
 	</colgroup>
 	<tbody> 
-		<tr>
-			<td><strong>Configuration</strong></td>
+		<tr align="center">
+			<td><strong>Group</strong></td>
+			<td><strong>Description</strong></td>
+		</tr>
+		<tr valign="top" >
+			<td valign="top" ><strong>Configuration</strong></td>
 			<td><a href="cdt_u_prop_all.htm">Click here for a description.</a></td>
 		</tr>
-		<tr>
-			<td><strong>Manage configurations</strong></td>
+		<tr valign="top" >
+			<td valign="top" ><strong>Manage Configurations...</strong></td>
 			<td><a href="cdt_u_prop_all.htm">Click here for a description.</a></td>
 		</tr>
-		<tr>
-			<td><strong>Discovery Profiles Scope</strong></td>
+		<tr valign="top" >
+			<td valign="top" ><strong>Discovery Profiles Scope</strong></td>
 			<td>Specifies the type of profile to set for discovery:
 			  <ul>
 			    <li><strong>Per Language</strong> - Enables the association of different profiles with different resource types (different tools and input types), to have different settings discovered, e.g. for C and C++ source files and for different tools used by the project.
@@ -44,51 +45,57 @@ the entire project (configuration). This means that both the project and per-fil
 			
 			</td>
 		</tr>
-		<tr>
-			<td>Left pane list (language specific)</td>
+		<tr valign="top" >
+			<td valign="top" ><strong>Tools</strong> (language specific list)</td>
 			<td>Shows a list of language specific compilers. Select a language from the list.</td>
 		</tr>
-		<tr>
+		<tr valign="top" >
+			<td colspan="2" ><strong>Automated discovery of paths and symbols</strong></td>
+		</tr>
+		<tr valign="top" >
 			<td><strong>Automate discovery of paths and symbols</strong></td>
 			<td>Scans the build output to populate the path and symbol tables, such as symbol definitions, system include directories, local include directories, macros, and include files.</td>
 		</tr>
-				<tr>
+		<tr valign="top" >
 			<td><strong>Report path detection problems</strong></td>
 			<td>Sets the notification of diagnostic errors for include paths that the Eclipse CDT is unable to resolve as it parses the build output.</td>
 		</tr>
-		<tr>
+		<tr valign="top" >
 			<td><strong>Discovery profile</strong></td>
 			<td>Indicates the discovery profile to use for paths and symbol detection. The type of <strong>Configuration</strong> and <strong>Discovery Profile Scope</strong> you specify determine what which <strong>Discovery Profile</strong> options display on this tab.</td>
 		</tr>		
-		<tr>
+		<tr valign="top" >
+			<td colspan="2" ><strong>Discovery profile options</strong></td>
+		</tr>
+		<tr valign="top" >
 			<td><strong>Enable build output scanner info discovery</strong></td>
 			<td>Configures the scanner to parse the output from a build for compiler commands with options that specify the definition of preprocessor symbols, and include search paths (for GCC compiler, -D and -I respectively). This button is only visible when <strong>Configuration</strong> is set to Release and the <strong>Discovery Profiles Scope</strong> is set to <strong>Configuration-wide</strong>.</td>
 		</tr>
-		<tr>
+		<tr valign="top" >
+			<td><strong>Load build output from file</strong></td>
+			<td>Specifies the name of the file you selected to load the build output from. </td>
+		</tr>
+		<tr valign="top" >
 			<td><strong>Load</strong></td>
 			<td>Lets you load a file to discover paths and symbols based on a previous builds' output. To activate the discovery select a build log file and then the <strong>Load</strong> button. This button is only visible when <strong>Configuration</strong> is set to Release and the <strong>Discovery Profiles Scope</strong> is set to <strong>Configuration-wide</strong>.
 			<p><strong>Note:</strong> Click <strong>Variables</strong> to open the Select Variables window to define a build output file.</p>
 			</td>
 		</tr>
-		<tr>
-			<td><strong>Load build output from file</strong></td>
-			<td>Specifies the name of the file you selected to load the build output from. This button is only visible when <strong>Configuration</strong> is set to Release and the <strong>Discovery Profiles Scope</strong> is set to <strong>Configuration-wide</strong>.</td>
-		</tr>
-		<tr>
-			<td><strong>Browse</strong></td>
+		<tr valign="top" >
+			<td><strong>Browse...</strong></td>
 			<td>Click to locate a previously built output file to load the build output from. This button is only visible when <strong>Configuration</strong> is set to Release and the <strong>Discovery Profiles Scope</strong> is set to <strong>Configuration-wide</strong>.</td>
 		</tr>
-		<tr>
-			<td><strong>Variables</strong></td>
+		<tr valign="top" >
+			<td><strong>Variables...</strong></td>
 			<td>Click to specify an argument for, or create and configure simple launch variables which you can reference in launch configurations that support variables. This button is only visible when <strong>Configuration</strong> is set to Release and the <strong>Discovery Profiles Scope</strong> is set to <strong>Configuration-wide</strong>.</td>
 		</tr>
-		<tr>
+		<tr valign="top" >
 			<td><strong>Enable generate scanner info command</strong></td>
 			<td>Enables the retrieval of information from the scanner. If it is not selected, the includes will be populated with default gcc system includes; Eclipse gathers the compiler settings based on the specified toolchain. This means that the Eclipse CDT can obtain the default gcc system includes to associate with the project. 
 				<p>When selected, you can specify any required compiler specific commands in the <strong>Compiler invocation command</strong> field.</p>
 			</td>
 		</tr>
-		<tr>
+		<tr valign="top" >
 			<td><strong>Compiler invocation command</strong></td>
 			<td>Indicates the compiler specific command used to invoke the compiler (such as <span class="typewriter">gcc</span>, or more complicated commands used to perform all necessary steps for compiling C/C++ source files into .o files, and linking the object files and libraries into an executable program. For example, the command <strong>gcc -E -P -v hello.c | hello.cpp</strong> reads a compiler's configuration file and prints out information that includes the compiler's internally defined preprocessor symbols and include search paths. The information is complementary to the scanner configuration discovered when the output is parsed (if you've enabled the <strong>Enable build output scanner info discovery</strong> option), and is added to the project's scanner configuration. You can click <strong>Browse</strong> to locate this command, if required.
 			
@@ -108,12 +115,16 @@ the entire project (configuration). This means that both the project and per-fil
         <li><samp>-iwithprefix <span style="font-style: italic;">dir</span></samp></li>
         <li><samp>-iwithprefixbefore <span style="font-style: italic;">dir</span></samp></li>
       </ul>
-			</td>
+	    </td>
 		</tr>
-			<tr>
-			<td><strong>Browse</strong></td>
+		<tr valign="top" >
+			<td><strong>Browse...</strong></td>
 			<td>Click to browse for a file to include in the compiler invocation command. This button is only visible when <strong>Configuration</strong> is set to Release and the <strong>Discovery Profiles Scope</strong> is set to <strong>Configuration-wide</strong>.</td>
 		</tr>
+		<tr valign="top" >
+			<td><strong>Compiler invocation arguments</strong></td>
+			<td>Enter additional arguments to send to the chosen compiler.</td>
+		</tr>
   </tbody>
 </table>
 	
@@ -159,7 +170,7 @@ the entire project (configuration). This means that both the project and per-fil
 <li><a href="cdt_u_prop_rundebug.htm">C/C++ Project Properties, Run/Debug Settings page</a>
 </ul>
 </p>
-
+<hr />
 <p><img src="../images/ng00_04a.gif" ALT="QNX Copyright Statement" ></p>
 </body>
 </html>
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_prop_build_environment.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_prop_build_environment.htm
index 30d31fad0eb..216ab4669a1 100644
--- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_prop_build_environment.htm
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_prop_build_environment.htm
@@ -9,26 +9,28 @@
 
 <body>
 <h1>C/C++ Project Properties, Environment</h1>
-Customizes the build environment for all projects in the workspace; it lets you control the environment variables used by the build.
+Use the <strong>Environment</strong> property page to customize the build environment for all projects in the workspace; it lets you control the environment variables used by the build.
 <p><img img="" src="../images/prop_environment.png"
  alt="C/C++ Project Properties, Environment"></p>
 <p></p>
 
-<table cellpadding="5" cellspacing="0" border="1" >
-	<br>
-		<caption><strong>Environment preference options</strong></caption>
-	<br>	
+<table cellpadding="5" cellspacing="0" border="1" width="600px" bordercolor="#DDDDDD" >
+	<caption><strong>Environment preference options</strong></caption>
 	<colgroup>
 		<col width="30%" valign="top" >
 		<col width="70%" valign="top" >
 	</colgroup>
 	<tbody> 
+		<tr align="center">
+			<td><strong>Group</strong></td>
+			<td><strong>Description</strong></td>
+		</tr>
 		<tr>
 			<td><strong>Configuration</strong></td>
 			<td><a href="cdt_u_prop_all.htm">Click here for a description.</a></td>
 		</tr>
 		<tr>
-			<td><strong>Manage configurations</strong></td>
+			<td><strong>Manage Configurations...</strong></td>
 			<td><a href="cdt_u_prop_all.htm">Click here for a description.</a></td>
 		</tr>
 		<tr>
@@ -52,20 +54,20 @@ Customizes the build environment for all projects in the workspace; it lets you
 			<td>Replaces the native environment with the specified variables, and then restores the native environment upon its completion.</td>
 		</tr>		
 		<tr>
-			<td><strong>New</strong></td>
-			<td>Opens a dialog to create a new environment variable and value. Custom environment variables that you create appear in bold within the list.
-			<p><img img="" src="../images/cdt_buildenv_newenvvar.png" alt="C/C++ Project Properties, Environment, New environment variable"></p>            <br>
+			<td><strong>Add...</strong></td>
+			<td>Opens the <strong>New variable</strong> dialog to create a new environment variable and value. Custom environment variables that you create appear in bold within the list.
+			<p><img img="" src="../images/cdt_buildenv_newenvvar.png" alt="C/C++ Project Properties, Environment, New environment variable"></p> 
             <p>Click <strong>Variables</strong> to Select variables by name to include in the value. Select <strong>Add to all configurations</strong> to make this new environment variable available to all configurations for the selected project; otherwise, the variable is only available for the currently selected configuration.</p>
 			</td>
 		</tr>
 		<tr>
-			<td><strong>Select</strong></td>
-			<td>Opens the Select variables dialog where you can choose from a list of system variables.
+			<td><strong>Select...</strong></td>
+			<td>Opens the <strong>Select variables</strong> dialog where you can choose from a list of system variables.
 			<p><img img="" src="../images/cdt_buildenv_selectvar.png" alt="C/C++ Project Properties, Environment, New environment variable"></p></td>
             </td>
 		</tr>
 		<tr>
-			<td><strong>Edit</strong></td>
+			<td><strong>Edit...</strong></td>
 			<td>Modifies the name and value of the selected environment variable.</td>
 		</tr>
 		<tr>
@@ -138,8 +140,8 @@ Customizes the build environment for all projects in the workspace; it lets you
 <li><a href="cdt_u_prop_rundebug.htm">C/C++ Project Properties, Run/Debug Settings page</a>
 </ul>
 </p>
+<hr />
 <p><img src="../images/intl_07.gif" ALT="Intel Copyright Statement" ></p>
 
-
 </body>
 </html>
author	L. Frank Turovich	2010-05-08 21:15:37 +0000
committer	L. Frank Turovich	2010-05-08 21:15:37 +0000
commit	ef4a520f87092163b16da1a5ae1db73de98e0e48 (patch)
tree	6011e5be5c8114019a7ee82be8bafcd68fc73cd5 /doc/org.eclipse.cdt.doc.user
parent	6c9fbdda2e2e538e9659f0284b635699ca19681c (diff)
download	org.eclipse.cdt-ef4a520f87092163b16da1a5ae1db73de98e0e48.tar.gz org.eclipse.cdt-ef4a520f87092163b16da1a5ae1db73de98e0e48.tar.xz org.eclipse.cdt-ef4a520f87092163b16da1a5ae1db73de98e0e48.zip