Skip to main content
summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorL. Frank Turovich2010-04-21 23:56:13 -0400
committerL. Frank Turovich2010-04-21 23:56:13 -0400
commitb614dc1db22d81efb0a7f9e9bf47bcc993665713 (patch)
treed0123c09d81de7af5f014a8b8d549c0042ab09c5 /doc
parent6ff5f0ac40fba70896e4f19c37d146b274918f61 (diff)
downloadorg.eclipse.cdt-b614dc1db22d81efb0a7f9e9bf47bcc993665713.tar.gz
org.eclipse.cdt-b614dc1db22d81efb0a7f9e9bf47bcc993665713.tar.xz
org.eclipse.cdt-b614dc1db22d81efb0a7f9e9bf47bcc993665713.zip
Add Build Variables pref page and Add and Edit Build Variables task page
Diffstat (limited to 'doc')
-rw-r--r--doc/org.eclipse.cdt.doc.user/contexts_CDT.xml1
-rwxr-xr-xdoc/org.eclipse.cdt.doc.user/images/cdt_dlg_define_build_var.pngbin0 -> 11990 bytes
-rwxr-xr-xdoc/org.eclipse.cdt.doc.user/images/cdt_dlg_edit_build_var.pngbin0 -> 12333 bytes
-rwxr-xr-xdoc/org.eclipse.cdt.doc.user/images/cdt_pref_build_vars.pngbin0 -> 67229 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_vars.htm60
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_o_build_task.htm1
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_add_build_var.htm81
-rw-r--r--doc/org.eclipse.cdt.doc.user/topics_Reference.xml2
-rw-r--r--doc/org.eclipse.cdt.doc.user/topics_Tasks.xml2
9 files changed, 147 insertions, 0 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml b/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml
index e8f9cc1317..a268c5144d 100644
--- a/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml
+++ b/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml
@@ -371,6 +371,7 @@
<context id="cdt_u_prop_build_variables">
<description></description>
<topic href="reference/cdt_u_prop_build_variables.htm" label="Build Variables"/>
+ <topic href="tasks/cdt_t_add_build_var.htm" label="Adding and Editing Build Variables"/>
</context>
<context id="cdt_u_prop_build_discovery">
<description></description>
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_define_build_var.png b/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_define_build_var.png
new file mode 100755
index 0000000000..9190d6ea25
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_define_build_var.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_edit_build_var.png b/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_edit_build_var.png
new file mode 100755
index 0000000000..049a6e3cc5
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_edit_build_var.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_pref_build_vars.png b/doc/org.eclipse.cdt.doc.user/images/cdt_pref_build_vars.png
new file mode 100755
index 0000000000..850d2eb2de
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_pref_build_vars.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_vars.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_vars.htm
new file mode 100644
index 0000000000..3b4b51c74e
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_vars.htm
@@ -0,0 +1,60 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
+<html lang="en">
+
+<head>
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Build Variables preferences</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
+ <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
+</head>
+
+<body>
+
+<h1>Build Variables preferences</h1>
+
+<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=org.eclipse.cdt.managedbuilder.ui.preferences.PrefPage_Vars)")'>Build Variables</a> preference panel to add, edit, or remove local build variables. Local build variables are displayed in <b>bold</b> text.</p>
+<p><img src="../images/cdt_pref_build_vars.png" alt="Build Variables Preferences Page"></p>
+
+<table width="600px" cellpadding="5" cellspacing="0" border="1" fgcolor="DDD" >
+ <caption><strong>Build Variables Preference Options</strong></caption>
+ <colgroup>
+ <col width="30%" valign="top" >
+ <col width="70%" valign="top" >
+ </colgroup>
+ <thead>
+ <tr>
+ <th><b>Option</b></th>
+ <th><b>Description</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr valign="top" >
+ <td><b>Add...</b></td>
+ <td>Click to <a href="../tasks/cdt_t_add_build_var.htm">add</a> a new build variable in the <b>Define a New Build Variable</b> dialog box.</td>
+ </tr>
+ <tr valign="top" >
+ <td><b>Edit...</b></td>
+ <td>Click to edit the selected build variable.</td>
+ </tr>
+ <tr valign="top" >
+ <td><b>Remove</b></td>
+ <td>Click to remove the select build variable. <br /><br />
+ NOTE: System variables cannot be removed.</td>
+ </tr>
+ <tr valign="top" >
+ <td><b>Show system variables</b></td>
+ <td>Enable to display system variables in the variables list.</td>
+ </tr>
+ </tbody>
+</table>
+
+
+<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"><br>
+<a href="cdt_u_pref_build.htm">Build preferences</a></p>
+<hr>
+<img src="../images/nokiaCopyright.png" ALT="Nokia Copyright Statement" >
+
+</body>
+
+</html> \ No newline at end of file
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_build_task.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_build_task.htm
index 2b10b9aa82..b45a29deff 100644
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_build_task.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_build_task.htm
@@ -13,6 +13,7 @@
<p>The following topics explain how to build a project, and to manage compile errors:</p>
<img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_proj_rename.htm">Renaming a project</a><br>
<img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_proj_build_set.htm">Defining Project Build settings</a><br>
+ <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_add_build_var.htm">Adding and Editing Build Variables</a><br>
<img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_proj_error_parser.htm">Filtering errors</a><br>
<img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_proj_parser.htm">Selecting a binary parser</a><br>
<img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_proj_paths.htm">Adding include paths and symbols</a><br>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_add_build_var.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_add_build_var.htm
new file mode 100644
index 0000000000..8b6e1bf43a
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_add_build_var.htm
@@ -0,0 +1,81 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html lang="en">
+
+<head>
+<meta http-equiv="Content-Language" content="en-us">
+<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
+<meta name="ProgId" content="FrontPage.Editor.Document">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Adding and Editing Build Variables</title>
+<link rel="stylesheet" type="text/css" href="../help.css">
+<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
+</head>
+
+<body>
+
+<h1>Adding and Editing Build Variables</h1>
+
+<p>Use the <b>Define a New Build Variable</b> dialog box to add local build variables or the <b>Edit Existing Build Variable</b>
+dialog box to edit a previously defined variable. Both are accessible from the <img src="../images/command_link.png" border="0" alt="" /> <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.cdt.managedbuilder.ui.preferences.PrefPage_Vars)")'>Build Variables</a> preference panel.</p>
+
+<h2>Define a New Build Variable</h2>
+<p><ol>
+<li>Click <b>Window > Preferences > C/C++ > Build > Build Variables</b></li>
+<li>Click <b>Add...</b> in the <b>Build Variables</b> preference panel to open the <b>Define a New Build Variables</b> dialog box</li>
+<li>Enter the variable name</li>
+<li>Choose a variable type</li>
+<li>Enter the variables value</li>
+<li>Click <b>OK</b></li>
+</ol></p>
+
+<p><img src="../images/cdt_dlg_define_build_var.png" ALT="Define a New Build Variable dialog box" ></p>
+
+<table width="600px" cellpadding="5" cellspacing="0" border="1" fgcolor="DDD" >
+ <caption><strong>Define a New Build Variable/Edit Existing Build Variable Dialog Box Options</strong></caption>
+ <colgroup>
+ <col width="30%" valign="top" >
+ <col width="70%" valign="top" >
+ </colgroup>
+ <thead>
+ <tr>
+ <th><b>Option</b></th>
+ <th><b>Description</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><b>Variable name</b></td>
+ <td>Enter the variable name.</td>
+ </tr>
+ <tr>
+ <td><b>Type</b></td>
+ <td>Choose the variable type from the available list.</td>
+ </tr>
+ <tr>
+ <td><b>Value</b></td>
+ <td>Enter or edit the value of the variable.</td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Edit Existing Build Variable</h2>
+<p><ol>
+<li>Click <b>Window > Preferences > C/C++ > Build > Build Variables</b></li>
+<li>Select the local build variable to edit in the <b>Build Variables</b> preference panel</li>
+<li>Click <b>Edit...</b> to open the <b>Edit Existing Build Variable</b> dialog box</li>
+<li>Change the variable type (optional)</li>
+<li>Edit the variables value (optional)</li>
+<li>Click <b>OK</b></li>
+</ol></p>
+
+<p><img src="../images/cdt_dlg_edit_build_var.png" ALT="Define a New Build Variable dialog box" ></p>
+
+<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"><br />
+<a href="../reference/cdt_u_pref_build_vars.htm">Build Variables preferences</a></p>
+
+<hr>
+<img src="../images/nokiaCopyright.png" ALT="Nokia Copyright Statement" >
+
+</body>
+
+</html> \ No newline at end of file
diff --git a/doc/org.eclipse.cdt.doc.user/topics_Reference.xml b/doc/org.eclipse.cdt.doc.user/topics_Reference.xml
index 75d7c49995..de13b4db9a 100644
--- a/doc/org.eclipse.cdt.doc.user/topics_Reference.xml
+++ b/doc/org.eclipse.cdt.doc.user/topics_Reference.xml
@@ -55,6 +55,8 @@
<topic label="C/C++ preferences" href="reference/cdt_u_c_pref.htm">
<topic label="Appearance" href="reference/cdt_u_appearance_pref.htm"/>
<topic href="reference/cdt_u_pref_build.htm" label="Build preferences">
+ <topic href="reference/cdt_u_pref_build_vars.htm" label="Build Variables">
+ </topic>
<topic label="Console" href="reference/cdt_u_console_pref.htm"/>
<topic label="Environment" href="reference/cdt_u_environment_pref.htm"/>
<topic label="Make Targets" href="reference/cdt_u_make_pref.htm" />
diff --git a/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml b/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml
index 47526ca8eb..abe4d54139 100644
--- a/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml
+++ b/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml
@@ -30,6 +30,8 @@
<topic label="Building projects" href="tasks/cdt_o_build_task.htm">
<topic label="Renaming a project" href="tasks/cdt_t_proj_rename.htm"/>
<topic label="Defining Project Build settings" href="tasks/cdt_t_proj_build_set.htm"/>
+ <topic href="tasks/cdt_t_add_build_var.htm" label="Adding and Editing Build Variables">
+ </topic>
<topic label="Filtering Errors" href="tasks/cdt_t_proj_error_parser.htm"/>
<topic label="Selecting a binary parser" href="tasks/cdt_t_proj_parser.htm"/>
<topic label="Adding Include paths and symbols" href="tasks/cdt_t_proj_paths.htm"/>

Back to the top