Skip to main content
summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorL. Frank Turovich2010-05-12 22:21:52 -0400
committerL. Frank Turovich2010-05-12 22:21:52 -0400
commitc41cae33cbbcd751db6b5fafceb96dea522dd4fb (patch)
tree09d1cdf66e053885dbbddc039896f534ef812b78 /doc
parent53845ca38eb128661d3097bbce402c7875c2da2b (diff)
downloadorg.eclipse.cdt-c41cae33cbbcd751db6b5fafceb96dea522dd4fb.tar.gz
org.eclipse.cdt-c41cae33cbbcd751db6b5fafceb96dea522dd4fb.tar.xz
org.eclipse.cdt-c41cae33cbbcd751db6b5fafceb96dea522dd4fb.zip
Bug 310371 - Revised GDB, GDB MI, Indexer pref panels, and New CPP FIle, New File Name, and Editor pages
Diffstat (limited to 'doc')
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/debug_gdb_pref.pngbin12702 -> 30977 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNGbin30051 -> 61170 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/project_new_cppfile.pngbin5848 -> 13506 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/project_new_file.pngbin14757 -> 13859 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/project_new_file_name.pngbin9235 -> 24472 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/view_editor.pngbin6498 -> 13506 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/reference/cdt_u_console_pref.htm8
-rw-r--r--doc/org.eclipse.cdt.doc.user/reference/cdt_u_dsfgdb.htm8
-rw-r--r--doc/org.eclipse.cdt.doc.user/reference/cdt_u_editor_view.htm10
-rw-r--r--doc/org.eclipse.cdt.doc.user/reference/cdt_u_gdb_mi.htm49
-rw-r--r--doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html120
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_new_cpp.htm12
12 files changed, 124 insertions, 83 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/images/debug_gdb_pref.png b/doc/org.eclipse.cdt.doc.user/images/debug_gdb_pref.png
index eb6f666709..c781cb25f2 100644
--- a/doc/org.eclipse.cdt.doc.user/images/debug_gdb_pref.png
+++ b/doc/org.eclipse.cdt.doc.user/images/debug_gdb_pref.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG
index 8c7df66543..19b9b3e660 100644
--- a/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/project_new_cppfile.png b/doc/org.eclipse.cdt.doc.user/images/project_new_cppfile.png
index eabbd40134..b267152b34 100644
--- a/doc/org.eclipse.cdt.doc.user/images/project_new_cppfile.png
+++ b/doc/org.eclipse.cdt.doc.user/images/project_new_cppfile.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/project_new_file.png b/doc/org.eclipse.cdt.doc.user/images/project_new_file.png
index 27b3635317..300f29fbf8 100644
--- a/doc/org.eclipse.cdt.doc.user/images/project_new_file.png
+++ b/doc/org.eclipse.cdt.doc.user/images/project_new_file.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/project_new_file_name.png b/doc/org.eclipse.cdt.doc.user/images/project_new_file_name.png
index 5f5807f2d8..5fb029e387 100644
--- a/doc/org.eclipse.cdt.doc.user/images/project_new_file_name.png
+++ b/doc/org.eclipse.cdt.doc.user/images/project_new_file_name.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/view_editor.png b/doc/org.eclipse.cdt.doc.user/images/view_editor.png
index cc15e46de1..9374ea8ffb 100644
--- a/doc/org.eclipse.cdt.doc.user/images/view_editor.png
+++ b/doc/org.eclipse.cdt.doc.user/images/view_editor.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_console_pref.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_console_pref.htm
index 716b2b37da..b85cb27d03 100644
--- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_console_pref.htm
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_console_pref.htm
@@ -24,12 +24,8 @@
</colgroup>
<thead>
<tr>
- <th>
- <strong>Option</strong>
- </th>
- <th>
- <strong>Description</strong>
- </th>
+ <th><strong>Option</strong></th>
+ <th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_dsfgdb.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_dsfgdb.htm
index 34cf61cc82..2b7db42630 100644
--- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_dsfgdb.htm
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_dsfgdb.htm
@@ -12,10 +12,8 @@
<h1>GDB Debugging Preferences</h1>
-<p>Use the <strong>GDB</strong> preferences panel to control how the CDT debugger behaves when debugging with GDB,
+<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.dsf.gdb.ui.preferences)")'>GDB</a> preferences panel to control how the CDT debugger behaves when debugging with GDB,
specifically when using a <em>GDB (DSF)</em> launcher.
-The page is accessible at:
-<strong>Window &gt; Preferences &gt; C/C++ &gt; Debug &gt; GDB</strong>.</p>
<p><img src="../images/cdt_dsfgdb_preferences_page.png" alt="GDB preferences panel"></p>
@@ -45,6 +43,10 @@ The page is accessible at:
<img src="../images/cdt_debug_hover_modes.png" alt="debug hover modes"></td>
</tr>
</table>
+<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <br>
+<a href="../reference/cdt_u_gdb_mi.htm">GDB MI Debug preferences</a></p>
+<hr />
+<p><img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" ></p>
</body>
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_editor_view.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_editor_view.htm
index d309ae1379..acf6a27dc0 100644
--- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_editor_view.htm
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_editor_view.htm
@@ -10,9 +10,9 @@
<body>
<h1>Editor view</h1>
- <p>The C/C++ editor provides specialized features for editing C/C++ related files.</p>
+ <p>The <strong>C/C++ editor</strong> provides specialized features for editing C/C++ related files.</p>
<p><img src="../images/view_editor.png" alt="C/C++ Editor" ></p>
- <p>Associated with the editor is a C/C++-specific <a href="cdt_u_outline_view.htm">Outline view</a>,
+ <p>Associated with the editor is a C/C++-specific <a href="cdt_u_outline_view.htm">Outline</a> view,
which shows the structure of the active C, C++ or makefile. It is updated as you edit these files.</p>
<p>The editor includes the following features:</p>
@@ -27,12 +27,10 @@
(single or double-click depending on the user preferences).</p>
<p>The C/C++ editor does not contain a toolbar itself, but relies on the use of the main
-<a href="cdt_u_toolbar.htm">toolbar</a>, <a href="cdt_u_m_edit.htm">edit menu</a>, <a href="cdt_u_m_search.htm">search menu </a>
+<a href="cdt_u_toolbar.htm">toolbar</a>, <a href="cdt_u_m_edit.htm">Edit menu</a>, <a href="cdt_u_m_search.htm">Search menu </a>
and key binding actions.</p>
-
-<p></p>
-
+<hr />
<p>
<img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" >
</p>
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_gdb_mi.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_gdb_mi.htm
index b128a62ecb..42c1b9cb89 100644
--- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_gdb_mi.htm
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_gdb_mi.htm
@@ -6,25 +6,50 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Debug GDB MI page, Preferences window</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>Debug GDB MI page, Preferences window</h1>
-<p>You can manipulate certain GDB timeout settings <strong>Window &gt; Preferences &gt; C/C++ &gt; Debug &gt; GDB MI</strong>.</p>
-
-<img src="../images/debug_gdb_pref.png" alt="Debug GDB MI Preferences">
-<dl>
- <dt>Debugger timeout (ms)</dt>
- <dd>Sets the timeout value for the debugger.</dd>
- <dt>Launch timeout (ms)</dt>
- <dd>Sets the Launch timeout for a debug session.</dd>
- <dt>Automatically refresh modules</dt>
- <dd>Controls the updates of the Modules view</dd>
-</dl>
+<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.ui.preferneces.CBuildConsolePreferernces)")'>GDB MI</a> preference panel to manipulate certain GDB timeout settings.</p>
+<p><img src="../images/debug_gdb_pref.png" alt="Debug GDB MI Preferences"></p>
+<table width="700px" cellpadding="5" cellspacing="0" border="1" bordercolor="#DDDDDD" >
+ <caption><strong>GDB MI Preference Options</strong></caption>
+ <colgroup>
+ <col width="30%" valign="top" >
+ <col width="70%" valign="top" >
+ </colgroup>
+ <thead>
+ <tr>
+ <th><strong>Option</strong></th>
+ <th><strong>Description</strong></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr valign="top" >
+ <td><strong>Debugger timeout (ms)</strong></td>
+ <td>Sets the timeout value for the debugger. Default setting is 10000 milliseconds.</td>
+ </tr>
+ <tr valign="top" >
+ <td><strong>Launch timeout (ms)</strong></td>
+ <td>Sets the Launch timeout for a debug session. Default setting is 30000 milliseconds.</td>
+ </tr>
+ <tr valign="top" >
+ <td><strong>Automatically refresh modules</strong></td>
+ <td>Controls the updates of the Modules view.</td>
+ </tr>
+ <tr valign="top" >
+ <td><strong>Support distinct code and data memory spaces</strong></td>
+ <td>Toggle to swap between showing separate code and data memory spaced or not.</td>
+ </tr>
+</table>
+<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <br>
+<a href="../reference/cdt_u_dsfgdb.htm">GDB Debugging preferences</a></p>
+<hr />
<p><img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" ></p>
-
</body>
</html> \ No newline at end of file
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html
index 6dfc173570..455634d826 100644
--- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html
@@ -5,73 +5,92 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Indexer preferences (C/C++)</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>Indexer preferences (C/C++)</h1>
-<p>Use the <strong>Indexer</strong> preference page to select the indexer used by default for new projects and configure its behavior.</p>
-<p> <img src="../images/indexer_preference_page.PNG"
- alt="Indexer Preferences Window" ><br>
+<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.ui.preferences.IndexerPreferencePage)")'>Indexer</a> preference panel to select the indexer used by default for new projects and configure its behavior.</p>
+<p> <img src="../images/indexer_preference_page.png" alt="Indexer Preferences Window" ><br>
</p>
-<table width="600" cellpadding="5" cellspacing="0" border="1" >
- <caption>
- <strong>Indexer Options</strong>
- </caption>
+<table width="700" cellpadding="5" cellspacing="0" border="1" bordercolor="#DDDDDD" >
+ <caption><strong>Indexer Options</strong></caption>
<colgroup>
<col width="30%" valign="top" >
<col width="70%" valign="top" >
</colgroup>
<tbody>
- <tr>
- <td width="241" valign="top"><strong>Select Indexer </strong></td>
- <td width="333" valign="top">Select the indexer to use by default for all new projects. </td>
+ <tr>
+ <th><strong>Option</strong></th>
+ <th><strong>Description</strong></th>
+ </tr>
+ <tr valign="top">
+ <td><strong>Select Indexer </strong></td>
+ <td>Select the indexer to use by default for all new projects. </td>
</tr>
- <tr>
- <td valign="top"><strong>Index all files (files neither built nor included, also) </strong></td>
- <td valign="top">Activate this checkbox to index all files </td>
+
+ <tr valign="top">
+ <td><strong>Index source files not included in the build</strong></td>
+ <td>Activate this checkbox to index all source files used by the project.</td>
</tr>
- <tr>
- <td valign="top"><strong>Skip all references (Call Hierarchy and Search will not work) </strong></td>
- <td valign="top">Activate this checkbox to not index references to save space and gain performance. This prevents some portions of CDT from working, like Call Hierarchy and search for references. </td>
+ <tr valign="top">
+ <td><strong>Index unused headers</strong></td>
+ <td>Activate this checkbox to index unused header files.</td>
</tr>
- <tr>
- <td valign="top"><strong>Skip type references (Search for type references will not work) </strong></td>
- <td valign="top">Activate this checkbox to not index type references. This prevents some portions of CDT from working, like Search for type references. </td>
+ <tr valign="top">
+ <td><strong>Allow heuristic resolution of includes </strong></td>
+ <td>Activate this checkbox to allow the indexer to skip indexing duplicate include files. </td>
+ </tr>
+
+ <tr valign="top">
+ <td><strong>Skip files larger than</strong></td>
+ <td>Enter the maximum file size to skip when indexing.</td>
</tr>
- <tr>
- <td valign="top"><strong>Skip macro references (Search for macro references will not work) </strong></td>
- <td valign="top">Activate this checkbox to not index macro references. This prevents some portions of CDT from working, like Search for macro references. </td>
+ <tr valign="top">
+ <td><strong>Skip all references (Call Hierarchy and Search will not work) </strong></td>
+ <td>Activate this checkbox to not index references to save space and gain performance. This prevents some portions of CDT from working, like Call Hierarchy and search for references. </td>
+ </tr>
+ <tr valign="top">
+ <td><strong>Skip implicit references (e.g. overloaded operators) </strong></td>
+ <td>Activate this checkbox to not index implicit references.</td>
+ </tr>
+ <tr valign="top">
+ <td><strong>Skip type and macro references (Search for these references will not work) </strong></td>
+ <td>Activate this checkbox to not index macro or type references. This prevents some portions of CDT from working, like Search. </td>
</tr>
- <tr>
- <td valign="top"><strong>Files to index up-front </strong></td>
- <td valign="top">Type a comma separated list of files that should always be indexed immediately. </td>
+ <tr valign="top">
+ <td><strong>Files to index up-front </strong></td>
+ <td>Type a comma separated list of files that should always be indexed immediately. </td>
+ </tr>
+
+ <tr valign="top">
+ <td><strong>Automatically update the index </strong></td>
+ <td>Activate this checkbox to have the index automatically update as it requires. </td>
</tr>
- <tr>
- <td valign="top"><strong>Automatically update the index </strong></td>
- <td valign="top">Activate this checkbox to have the index automatically update as it requires. </td>
+ <tr valign="top">
+ <td><strong>Update index immediately after every file change </strong></td>
+ <td>Activate this checkbox to force an index update whenever a file is saved. </td>
</tr>
- <tr>
- <td valign="top"><strong>Update index immediately after every file change </strong></td>
- <td valign="top">Activate this checkbox to force an index update whenever a file is saved. </td>
+
+ <tr valign="top">
+ <td><strong>Use active build configuration </strong></td>
+ <td>Activate to always use the active build configuration indexer settings to build the index. </td>
</tr>
- <tr>
- <td valign="top"><strong>Use active build configuration </strong></td>
- <td valign="top">Activate this checkbox to always use the active build configuration indexer settings to build the index. </td>
+ <tr valign="top">
+ <td><strong>Use the build configuration specified in the project's indexer settings </strong></td>
+ <td>Activate to always use the project's indexer settings to build the index. </td>
</tr>
- <tr>
- <td valign="top"><strong>Use the build configuration specified in the project's indexer settings </strong></td>
- <td valign="top">Activate this checkbox to always use the project's indexer settings to build the index. </td>
+
+ <tr valign="top">
+ <td><strong>Index database cache: Limit relative to the maximum heap size </strong></td>
+ <td>Specify the relative size limit the index can reach based on the maximum heap size. </td>
</tr>
- <tr>
- <td valign="top"><strong>Limit relative to the maximum heap size </strong></td>
- <td valign="top">Specify the relative size limit the index can reach based on the maximum heap size. </td>
+ <tr valign="top">
+ <td><strong>Index database cache: Absolute limit </strong></td>
+ <td>Specify the maximum size the index database cache is limited to. </td>
</tr>
- <tr>
- <td valign="top"><strong>Index database cache: Absolute limit </strong></td>
- <td valign="top">Specify the maximum size the index database cache is limited to. </td>
- </tr>
- <tr>
- <td valign="top"><strong>Header file cache: Absolute limit </strong></td>
- <td valign="top">Specify the maximum size the header file cache is limited to. </td>
+ <tr valign="top">
+ <td><strong>Header file cache: Absolute limit </strong></td>
+ <td>Specify the maximum size the header file cache is limited to. </td>
</tr>
</tbody>
</table>
@@ -91,9 +110,10 @@ editor</a></p>
<a href="cdt_u_m_search.htm">Search action</a><br>
<a href="cdt_u_search_view.htm">Search view</a><br>
</p>
-<p><img src="../images/nokiaCopyright.png" alt="Nokia Copyright Statement" width="375" height="12"><br>
- <img src="../images/ng00_05a.gif" alt="Copyright"
- style="width: 324px; height: 14px;"><br>
+<hr />
+<p>
+ <img src="../images/ng00_05a.gif" alt="Copyright IBM statement" ><br />
+ <img src="../images/nokiaCopyright.png" alt="Nokia Copyright Statement" width="375" height="12">
</p>
<p>
</p>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_new_cpp.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_new_cpp.htm
index 2111ee4984..bc8e2aee63 100644
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_new_cpp.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_new_cpp.htm
@@ -17,15 +17,15 @@ function changeSize(theImage,wd,ht) {
<body>
<h1>Creating a C/C++ file</h1>
<p>Files are edited in the C/C++ editor that is, by default, located in
-the editor area to the right of the C/C++ Projects view.</p>
+the editor area to the right of the <a href="../reference/cdt_u_project_explorer_view.htm">Project Explorer</a> or <a href="../reference/cdt_u_cproj_view.htm">C/C++ Projects</a> views.</p>
<p>The marker bar on the left margin of the C/C++ editor, displays
icons for errors, warnings, bookmarks, breakpoints and tasks.</p>
<p>For more information on the marker bar, see <strong>Workbench User Guide
&gt; Reference &gt; User interface information &gt; Views and editors
&gt; Editor area</strong>.</p>
-<p>To create a C++ file:</p>
+<h3>To create a C++ file:</h3>
<ol>
- <li>In the <strong>C++ Projects</strong> view, right-click a project, and
+ <li>In the <strong>Project Explorer</strong> or <strong>C++ Projects</strong> view, right-click a project, and
select <strong>New &gt; File</strong>.<br>
<img src="../images/project_new_file.png"
alt="New &gt; File in Projects View"></li>
@@ -36,9 +36,8 @@ appropriate extension.</li>
<li>Click <strong>Finish</strong>.<br>
<img src="../images/project_new_file_name.png" alt="New File Wizard"></li>
<p>The file will open in the C/C++ editor.</p>
- <li>Enter your code in the editor view..<br>
- <img src="../images/project_new_cppfile.png"
- alt="Editor view with a sample code"></li>
+ <li>Enter your code in the editor view.<br>
+ <img src="../images/project_new_cppfile.png" alt="Editor view with a sample code"></li>
<li>Type <strong>CTRL+S</strong> to save the file.</li>
</ol>
<p><img border="0" src="../images/ngconcepts.gif" alt="Related concepts"
@@ -58,6 +57,7 @@ Projects view</a></p>
width="143" height="21">
<br>
<a href="../reference/cdt_o_proj_prop_pages.htm">Project properties</a></p>
+<hr />
<p>
<img src="../images/ng00_04a.gif" alt="IBM Copyright Statement"></p>
</body>

Back to the top