mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-09 18:56:02 +02:00
Code Issues Wiki Activity

Bug 312167 - Revised several Task pages to make them current.

Browse source
This commit is contained in:
L. Frank Turovich 2010-05-09 17:11:10 +00:00
parent 6f3f7a3c1a
commit 690f511f36
15 changed files with 62 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
doc/org.eclipse.cdt.doc.user/images/cdt_menu_toggle_comments.png Executable file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.2 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/create_make_target.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 25 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/create_make_target_win.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/new_proj_convert.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 28 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/new_proj_convert_candidate.png Executable file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 35 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/view_make_targets.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.6 KiB

After

Width:  |  Height:  |  Size: 9.1 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/view_projects.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

2
doc/org.eclipse.cdt.doc.user/reference/cdt_u_view_executables.htm
View file

@ -26,7 +26,7 @@
<p>In addition, an <strong>Executables</strong> project is created in the <a href="cdt_u_project_explorer_view.htmview_ex">Project Explorer</a> view. The binaries shown in the Executables project can be deleted which also removes them from the Executables view. For binaries outside the workspace you must import them into the Executables view so their symbolics can be used during the debug session. <span class="note">You can also drag and drop executables into the view. </span></p> <p>In addition, an <strong>Executables</strong> project is created in the <a href="cdt_u_project_explorer_view.htmview_ex">Project Explorer</a> view. The binaries shown in the Executables project can be deleted which also removes them from the Executables view. For binaries outside the workspace you must import them into the Executables view so their symbolics can be used during the debug session. <span class="note">You can also drag and drop executables into the view. </span></p>
<p><img src="../images/view_executables.png" width="813" height="309" alt="Executables view"/></p> <p><img src="../images/view_executables.png" width="813" height="309" alt="Executables view"/></p>
<p>The <strong>Executables</strong> view consists of the Executable Name and Source File Name panes described in the table below. Use the Columns button in the toolbar to show or hide specific columns in each pane. Columns can be sorted and rearranged in the order desired. </p> <p>The <strong>Executables</strong> view consists of the Executable Name and Source File Name panes described in the table below. Use the Columns button in the toolbar to show or hide specific columns in each pane. Columns can be sorted and rearranged in the order desired. </p>
<table border="1" cellpadding="4" cellspacing="0" style="border-collapse: collapse" bordercolor="#DDD" width="600"> <table border="1" cellpadding="4" cellspacing="0" style="border-collapse: collapse" bordercolor="#DDD" width="700">
<caption><strong>Executables View Options</strong></caption> <caption><strong>Executables View Options</strong></caption>
<tr> <tr>
<th width="20%" scope="col">Pane</th> <th width="20%" scope="col">Pane</th>

25
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_cbuild_pref.htm
View file

@ -8,25 +8,19 @@
</head> </head>
<body> <body>
<h1>Customizing the Console view</h1> <h1>Customizing the Console view</h1>
<p>The Console view displays the output of the utilities invoked when <p>The <a href="../reference/cdt_u_console_view.htm">Console</a> view displays the output of the utilities invoked when
building a project or the programs output when running/debugging.</p> building a project or the programs output when running/debugging.</p>
<p>To set Console view preferences</p> <p>To set Console view preferences</p>
<ol> <ol>
<li>Click <strong>Window &gt; Preferences</strong>.</li> <li>Click <strong>Window &gt; Preferences</strong>.</li>
<li>Expand <strong>C/C++</strong> and click <strong>Build Console</strong>.<br> <li>Expand <strong>C/C++</strong> and <strong>Build</strong>, then click <strong>Console</strong>.<br>
<img src="../images/BuildConsole.png" alt="Build Console Properties"></li> <img src="../images/cdt_pref_build_console.png" alt="Console Properties" margin="10" ></li>
<li>To display information on the latest build only, select the <strong>Always <li>To display information on the latest build only, select the <strong>Always clear console before building</strong> check box.</li>
clear console before building</strong> check box.</li> <li>To open the Console view when a project is built, select the <strong>Open console when building</strong> check box.</li>
<li>To open the Console view when a project is built, select the <strong>Open <li>To display the console if it is already open when a project is built, select the <strong>Bring console to top when building (if present)</strong> check box.</li>
console when building</strong> check box.</li> <li>To change the number of lines the console stores in its history, enter a new value in the text field next to <strong>Limit console output (#lines)</strong>.</li>
<li>To display the console if it is already open when a project is <li>To change the number of spaces displayed by a tab, enter the number in the txt field next to <strong>Display tab width</strong>.</li>
built, select the <strong>Bring the console to top when building (if <li>To customize the colors used in the <strong>Console</strong> view, click a color control and select the new color.</li>
present)</strong> check box.</li>
<li>To change the number of lines the console stores in its history,
enter a new value in the text field next to <strong>Limit console output (#
lines)</strong>.</li>
<li>To change the number of spaces displayed by a tab, enter the
number in the txt field next to <strong>Display tab width</strong>.</li>
<li>Click <strong>OK</strong>.</li> <li>Click <strong>OK</strong>.</li>
</ol> </ol>
<p><img border="0" src="../images/ngconcepts.gif" alt="Related concepts" <p><img border="0" src="../images/ngconcepts.gif" alt="Related concepts"
@ -41,6 +35,7 @@ number in the txt field next to <strong>Display tab width</strong>.</li>
<p><img border="0" src="../images/ngref.gif" alt="Related reference" <p><img border="0" src="../images/ngref.gif" alt="Related reference"
width="143" height="21"> <br> width="143" height="21"> <br>
<a href="../reference/cdt_o_views.htm">Views</a></p> <a href="../reference/cdt_o_views.htm">Views</a></p>
<hr />
<img src="../images/ng00_04a.gif" alt="IBM Copyright Statement"> <img src="../images/ng00_04a.gif" alt="IBM Copyright Statement">
</body> </body>
</html> </html>

27
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_comment_out.htm
View file

@ -12,26 +12,32 @@
<h1>Commenting out code</h1> <h1>Commenting out code</h1>
<p>You can comment out one or more lines of code. The leading characters <samp>//</samp> <p>You can comment out one or more lines of code in any C/C++ editor view.
are added to the beginning of each line.</p> The leading characters <samp>//</samp> are added to the beginning of each line when commenting one or more lines of code.
You can also block comment multiple lines of code using the characters <samp>/* */</samp>.</p>
<p><strong>Tip:</strong> The characters <samp>/* */</samp> on lines that already are <p><strong>Tip:</strong> The characters <samp>/* */</samp> on lines that already are
already commented out are not affected when you comment and uncomment code as already commented out are not affected when you comment and uncomment code as
described above.</p> described above.</p>
<p>To comment out code:</p> <p><img src="../images/cdt_menu_toggle_comments.png" alt="Commenting out code menu choices"></p>
<p>To toggle <samp>//</samp> comments on code:</p>
<ol> <ol>
<li>In the C/C++ editor, select the line(s) of code that you want to comment out. If no lines are selected comments will be added (or removed) at the current cursor positition.</li> <li>In the C/C++ editor, select the line(s) of code that you want to comment out. If no lines are selected comments will be added (or removed) at the current cursor position.</li>
<li>Right-click and do one of the following:</li> <li>Right-click and select <strong>Source &gt; Toggle Comment</strong>. (<samp>CTRL+/</samp>)</li>
<ul>
<li>To comment out the selected code, select <strong>Comment</strong>.</li>
<li>To remove the leading <samp>//</samp> characters from the selected
line(s) of code, select <strong>Uncomment</strong>.</li>
</ul> </ul>
</ol> </ol>
<strong>Tip: </strong>Instead of using the context menu (right click) you can quickly comment out by pressing CTRL+/ or remove comments by pressing CTRL+\. <p>To block comment <samp>/* */</samp> code:</p>
<ol>
<li>In the C/C++ editor, select multiple line(s) of code to comment out.</li>
<li>To comment out multiple code lines right-click and select <strong>Source &gt; Add Block Comment</strong>. (<samp>CTRL+SHIFT+/</samp>)</li>
<li>To uncomment multiple code lines right-click and select <strong>Source &gt; Remove Block Comment</strong>. (<samp>CTRL+SHIFT+\</samp>)</li>
</ul>
</ol>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
<br> <br>
@ -43,6 +49,7 @@ described above.</p>
<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
<br> <br>
<a href="../reference/cdt_o_ceditor_pref.htm">C/C++ editor preferences</a></p> <a href="../reference/cdt_o_ceditor_pref.htm">C/C++ editor preferences</a></p>
<hr />
<img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" > <img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" >
</body> </body>

12
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_conv_proj.htm
View file

@ -12,7 +12,7 @@
<h1>Converting a C or C++ nature for a project</h1> <h1>Converting a C or C++ nature for a project</h1>
<p>You can assign a C nature to a C++ file or vice versa.</p> <p>Use the <strong>Convert to a C/C++ Project</strong> wizard to assign a C nature to a C++ project or vice versa.</p>
<p>To assign a C or C++ nature to a project</p> <p>To assign a C or C++ nature to a project</p>
@ -21,9 +21,11 @@
<img src="../images/new_proj_convert.png" alt="New Project window"></li> <img src="../images/new_proj_convert.png" alt="New Project window"></li>
<li>Click <strong>C</strong> or <strong>C++</strong>.</li> <li>Click <strong>C</strong> or <strong>C++</strong>.</li>
<li>Click <strong>Convert to C/C++ Make Project</strong>.</li> <li>Click <strong>Convert to C/C++ Make Project</strong>.</li>
<li>Click <strong>Next</strong>.</li> <li>Click <strong>Next</strong>.<br>
<li>In the Candidates for conversion list, select the projects to convert.</li> <img src="../images/new_proj_convert_candidate.png" alt="Convert C/C++ Project window"></li>
<li>In the Convert to C or C++ box, click <strong>C Project</strong> or <strong>C++ Project</strong>.</li> <li>In the <strong>Candidates for conversion</strong> list, select the projects to convert.</li>
<li>In the <strong>Convert to C or C++</strong> group, click <strong>C Project</strong> or <strong>C++ Project</strong>.</li>
<li>In the <strong>Project options</strong> group, you can specify the <strong>Project Type</strong> and <strong>Toolchain</strong> if the <strong>Specify project type</strong> option is enabled.</li>
<li>Click <strong>Finish</strong>.&nbsp;</li> <li>Click <strong>Finish</strong>.&nbsp;</li>
</ol> </ol>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
@ -36,7 +38,7 @@
<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
<br> <br>
<a href="../reference/cdt_o_proj_prop_pages.htm">Project properties</a></p> <a href="../reference/cdt_o_proj_prop_pages.htm">Project properties</a></p>
<hr />
<img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" > <img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" >
</body> </body>

11
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_create_make_target.htm
View file

@ -14,14 +14,13 @@
<p>To create a make target:</p> <p>To create a make target:</p>
<ol> <ol>
<li>Right click on the project and select <strong>Create Make Target...</strong></li><br> <li>Right click on the project and select <strong>Make Targets &gt; Create...</strong></li><br>
<img src="../images/create_make_target.png" alt="Select Create Make Target"><br>&nbsp;</li> <img src="../images/create_make_target.png" alt="Select Make Target, then Create"><br>&nbsp;</li>
<li>Enter the Target name and build options and click <strong>Create</strong>.<br> <li>Enter the <strong>Target name</strong> and build options and click <strong>OK</strong>.<br>
<img src="../images/create_make_target_win.png" alt="Create Make Target Window"><br>&nbsp;</li> <img src="../images/create_make_target_win.png" alt="Create Make Target Window"><br>&nbsp;</li>
<li>The make target will appear in the Make Targets view.<br> <li>The make target appear in the <strong>Make Targets</strong> view.<br>
<img src="../images/view_make_targets.png" alt="Make Targets View"><br>&nbsp;</li> <img src="../images/view_make_targets.png" alt="Make Targets View"><br>&nbsp;</li>
</ol> </ol>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
<br> <br>
<a href="../concepts/cdt_c_build_over.htm">Build overview</a></p> <a href="../concepts/cdt_c_build_over.htm">Build overview</a></p>
@ -32,8 +31,8 @@
<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <br> <p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <br>
<a href="../reference/cdt_u_create_make_target.htm">Create a Make Target</a><br> <a href="../reference/cdt_u_create_make_target.htm">Create a Make Target</a><br>
<a href="../reference/cdt_u_make_targets_view.htm">Make Target View</a></p> <a href="../reference/cdt_u_make_targets_view.htm">Make Target View</a></p>
<hr />
<img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" > <img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" >
</body> </body>
</html> </html>

12
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_disassembly.htm
View file

@ -14,15 +14,14 @@
<h1>Stepping into disassembled code</h1> <h1>Stepping into disassembled code</h1>
<p>Disassembly view lets you can examine your program as it steps into <p>The <a href="../images/cdt_u_dissassembly_view.htm">Disassembly</a> view lets you examine your program as it steps into
disassembled code. This is useful when the instruction pointer enters disassembled code. This is useful when the instruction pointer enters a function for which it does not have the source.
a function for which it does not have the source.
To open the Disassembly view select <strong>Window &gt; Show View &gt; To open the Disassembly view select <strong>Window &gt; Show View &gt;
Disassembly</strong> menu.</p> Disassembly</strong> menu.</p>
<p>To activate the insruction step mode check the <strong>Instruction Stepping Mode</strong> option <p>To activate the instruction step mode check the <strong>Instruction Stepping Mode</strong> option (<img src="../images/icon_db_step_mode.png" width="19" height="14" valign="middle" alt="Instruction Stepping Mode icon">)
on the Debug view toolbar. Debugger switches to the instruction stepping mode automatically on the <a href="../images/cdt_u_dbg_view.htm">Debug</a> view toolbar. The Debugger switches to the instruction stepping mode automatically
when the Disassembly view has focus.</p> when the <strong>Disassembly</strong> view has focus.</p>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
<br> <br>
@ -34,6 +33,7 @@ when the Disassembly view has focus.</p>
<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
<br> <br>
<a href="../reference/cdt_o_dbg_view.htm">Debug views</a></p> <a href="../reference/cdt_o_dbg_view.htm">Debug views</a></p>
<hr />
<img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" > <img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" >
</body> </body>

14
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search.htm
View file

@ -33,7 +33,11 @@ include paths and symbols are correctly defined. For more information, see
The info required to do a search is: The info required to do a search is:
<table border="1" cellpadding="2" valign="top"> <table border="1" cellpadding="4" cellspacing="0" valign="top" bordercolor="#DDDDDD" width="700px" >
<tr>
<th width="25%" scope="col">Option</th>
<th width="75%" scope="col">Explanation</th>
</tr>
<tr> <tr>
<td valign="top"><strong>Search string</strong></td> <td valign="top"><strong>Search string</strong></td>
<td valign="top">this is the name of the element you are looking for. See <a href="../concepts/cdt_c_search.htm">C/C++ search</a> for more information on how to specify wildcard searches and how to further refine your searches by using fully qualified names</td> <td valign="top">this is the name of the element you are looking for. See <a href="../concepts/cdt_c_search.htm">C/C++ search</a> for more information on how to specify wildcard searches and how to further refine your searches by using fully qualified names</td>
@ -84,7 +88,6 @@ The info required to do a search is:
</p> </p>
<h3>Using the C/C++ Search dialog</h3> <h3>Using the C/C++ Search dialog</h3>
<p> <img src="../images/search.png" alt="Search dialog box"></p> <p> <img src="../images/search.png" alt="Search dialog box"></p>
@ -96,7 +99,7 @@ The info required to do a search is:
<li>Select the <strong>Scope</strong>.</li> <li>Select the <strong>Scope</strong>.</li>
<li>Press <strong>Search</strong>.</li> <li>Press <strong>Search</strong>.</li>
</ol> </ol>
<p>Results are displayed in the <strong>Search</strong> view.</p> <p>Results are displayed in the <a href="../reference/cdt_u_search_view.htm">Search</a> view.</p>
<h3>Selecting an element in the Editor view</h3> <h3>Selecting an element in the Editor view</h3>
@ -106,8 +109,6 @@ The info required to do a search is:
</ol> </ol>
<p>Results are displayed in the <strong>Search</strong> view.</p> <p>Results are displayed in the <strong>Search</strong> view.</p>
<h3>Selecting an element in C/C++ Projects or Outline View</h3> <h3>Selecting an element in C/C++ Projects or Outline View</h3>
<ol> <ol>
@ -140,9 +141,8 @@ The info required to do a search is:
<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
<br> <br>
<a href="../reference/cdt_u_search.htm">C/C++ search page, Search dialog box</a></p> <a href="../reference/cdt_u_search.htm">C/C++ search page, Search dialog box</a></p>
<p>&nbsp;</p> <hr />
<img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" > <img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" >
</body> </body>
</html> </html>

12
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_show_proj_files.htm
View file

@ -12,23 +12,23 @@
<h1>Displaying C/C++ file components in the C/C++ Projects view</h1> <h1>Displaying C/C++ file components in the C/C++ Projects view</h1>
<p>File components are displayed in the C/C++ Projects view and in the Outline <p>File components are displayed in the <a href="../reference/cdt_u_cproj_view.htm">C/C++ Projects</a> view and in the <a href="../reference/cdt_u_outline_view.htm">Outline</a>
view. You can display or hide all file components in the C/C++ Projects view.</p> view. You can display or hide all file components in the C/C++ Projects view.</p>
<p>To display file components</p> <p>To display file components</p>
<ol> <ol>
<li>Click <strong>Window &gt; Preferences</strong>.</li> <li>Click <strong>Window &gt; Preferences</strong>.</li>
<li>In the Preferences dialog box, select <strong>C/C++ &gt; Appearance</strong> from the list.<br> <li>In the <strong>Preferences</strong> dialog box, select <strong>C/C++ &gt; Appearance</strong> from the list.<br>
<img src="../images/c_cpp_app_preferences.png" alt="Screen Capture of the C/C++ Appearance Preferences dialog box"></li> <img src="../images/view_appearance_prefs.png" alt="Screen Capture of the C/C++ Appearance Preferences dialog box"></li>
<li>Select the <strong>Show translation unit members</strong> check box.</li> <li>Select the <strong>Show translation unit members</strong> check box.</li>
<li>Click <strong>OK</strong>.</li> <li>Click <strong>OK</strong>.</li>
<li>In the C/C++ Projects view, double-click a file component.<br> <li>In the <strong>C/C++ Projects</strong> view, double-click a file component.<br>
The component is highlighted in the C/C++ editor.<br> The component is highlighted in the C/C++ editor.<br>
<img src="../images/view_projects.png" alt="C/C++ Projects view with file components"></li> <img src="../images/view_projects.png" alt="C/C++ Projects view with file components"></li>
</ol> </ol>
<p>The C/C++ Projects view can also be filtered to show certain types of file <p>The <strong>C/C++ Projects</strong> view can also be filtered to show certain types of file
components. For more information, see <a href="cdt_t_prvw_hide_files.htm">Hiding components. For more information, see <a href="cdt_t_prvw_hide_files.htm">Hiding
files by type in the C/C++ Projects view</a>.</p> files by type in the C/C++ Projects view</a>.</p>
@ -47,8 +47,8 @@ view</a><br>
<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
<br> <br>
<a href="../reference/cdt_o_ceditor_pref.htm">C/C++ editor preferences</a></p> <a href="../reference/cdt_o_ceditor_pref.htm">C/C++ editor preferences</a></p>
<hr />
<img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" > <img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" >
</body> </body>
</html> </html>