mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-23 14:42:11 +02:00
Code Issues Wiki Activity

bug 409392: Update context help and user documentation for new Scanner Discovery "Preprocessor Includes, Macros..." property/preference pages

Browse source
This commit is contained in:
Andrew Gvozdev 2013-06-08 08:15:17 -04:00
parent 110a511c63
commit ee0b58622c
3 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/org.eclipse.cdt.doc.user/concepts/cdt_c_scanner_discovery.htm
View file

@ -11,6 +11,8 @@
<div> <div>
<h1>Scanner Discovery</h1> <h1>Scanner Discovery</h1>
<p> <p>
<h2>General</h2>
<strong>Scanner Discovery</strong> (sometimes called <strong>Autodiscovery</strong>) is a method of finding include paths and predefined preprocessor macros which the compiler uses during compilation of the code. <strong>Scanner Discovery</strong> (sometimes called <strong>Autodiscovery</strong>) is a method of finding include paths and predefined preprocessor macros which the compiler uses during compilation of the code.
</p> </p>
@ -70,14 +72,33 @@ Each Language Settings Provider can be expanded to show the entries it discovere
If information retrieved by auto-discovery is insufficient or the project deviates from a standard one supported by CDT a user can enter additional include paths and macros manually under "User Settings Entries". If information retrieved by auto-discovery is insufficient or the project deviates from a standard one supported by CDT a user can enter additional include paths and macros manually under "User Settings Entries".
</p> </p>
<h2>Project Explorer View</h2>
<p> <p>
The <strong>Project Explorer View</strong> provides a means to view some of the settings. The discovered include paths are shown under the project when "Includes" node is expanded.<br> The <strong>Project Explorer View</strong> provides a means to view some of the settings. The discovered include paths are shown under the project when "Includes" node is expanded.<br>
Also, a <strong>"Wrench" overlay</strong> icon is shown for those file/folders where distinct entries are discovered which differ from those of parent folder. Wrench is not shown on project level.<br> Also, a <strong>"Wrench" overlay</strong> icon is shown for those file/folders where distinct entries are discovered which differ from those of parent folder. Wrench is not shown on project level.<br>
In the example below, <span class="typewriter">Hello.cpp</span> was compiled with added <span class="typewriter">-DHELLO</span> compiler option. In the example below, <span class="typewriter">Hello.cpp</span> was compiled with added <span class="typewriter">-DHELLO</span> compiler option.
After BOP discovery "Wrench" overlay is shown for this file. After BOP discovery "Wrench" overlay is shown for this file.
</p>
<p>
<img src="../images/scanner_discovery/sd_project_explorer.png" alt="Project Explorer view"> <img src="../images/scanner_discovery/sd_project_explorer.png" alt="Project Explorer view">
</p> </p>
<h2>Console View</h2>
<p>
The output of built-in compiler specs detectors can be inspected to troubleshoot problems running the command.
To do so, enable checkbox "Allocate console in the Console View".
</p>
<p>
<img src="../images/scanner_discovery/sd_specs_detector_options.png" alt="Spec Detectors Properties"></img>
</p>
<p>
When checkbox "Allocate console in the Console View" is enabled, output of each run of the provider will be directed to a special console in the Console View.
</p>
<p>
<img src="../images/scanner_discovery/sd_console_view.png" alt="Console View"></img>
</p>
<p><img src="../images/ngconcepts.gif" alt="Related concepts" width="143" height="21"><br> <p><img src="../images/ngconcepts.gif" alt="Related concepts" width="143" height="21"><br>
<a href="../concepts/cdt_c_indexer.htm">C/C++ Indexer</a><br> <a href="../concepts/cdt_c_indexer.htm">C/C++ Indexer</a><br>

BIN
doc/org.eclipse.cdt.doc.user/images/scanner_discovery/sd_console_view.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 46 KiB

1
doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_scanner_discovery.htm
View file

@ -201,6 +201,7 @@ Language settings providers can have options that affect the behavior of a provi
<td headers="field"><strong>Allocate console in the Console View</strong></td> <td headers="field"><strong>Allocate console in the Console View</strong></td>
<td headers="description2">Enable to troubleshoot problems running the command. <td headers="description2">Enable to troubleshoot problems running the command.
When enabled, output of each run of the provider will be directed to a special console in the Console View. When enabled, output of each run of the provider will be directed to a special console in the Console View.
See also <a href="../concepts/cdt_c_scanner_discovery.htm">Scanner Discovery</a> - Console View.
</td> </td>
</tr> </tr>
</tbody> </tbody>