Skip to main content
summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndrew Gvozdev2013-06-08 08:15:17 -0400
committerAndrew Gvozdev2013-06-08 08:15:17 -0400
commitee0b58622c31f59264f9d5da74f3a61dcfb8fa25 (patch)
tree29d5f96b6d898e4207297514bbe3ee6d8c188b6a /doc
parent110a511c63dc2addea97b9f5ff05f3ac5a5d951a (diff)
downloadorg.eclipse.cdt-ee0b58622c31f59264f9d5da74f3a61dcfb8fa25.tar.gz
org.eclipse.cdt-ee0b58622c31f59264f9d5da74f3a61dcfb8fa25.tar.xz
org.eclipse.cdt-ee0b58622c31f59264f9d5da74f3a61dcfb8fa25.zip
bug 409392: Update context help and user documentation for new Scanner Discovery "Preprocessor Includes, Macros..." property/preference pages
Diffstat (limited to 'doc')
-rw-r--r--doc/org.eclipse.cdt.doc.user/concepts/cdt_c_scanner_discovery.htm21
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/scanner_discovery/sd_console_view.pngbin0 -> 46797 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_scanner_discovery.htm1
3 files changed, 22 insertions, 0 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_scanner_discovery.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_scanner_discovery.htm
index ba333b2110..99f685d16a 100644
--- a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_scanner_discovery.htm
+++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_scanner_discovery.htm
@@ -11,6 +11,8 @@
<div>
<h1>Scanner Discovery</h1>
<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.
</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".
</p>
+<h2>Project Explorer View</h2>
+
<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>
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.
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">
</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>
<a href="../concepts/cdt_c_indexer.htm">C/C++ Indexer</a><br>
diff --git a/doc/org.eclipse.cdt.doc.user/images/scanner_discovery/sd_console_view.png b/doc/org.eclipse.cdt.doc.user/images/scanner_discovery/sd_console_view.png
new file mode 100644
index 0000000000..f308a2a131
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/scanner_discovery/sd_console_view.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_scanner_discovery.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_scanner_discovery.htm
index 0ae75fa321..189b0f2a51 100644
--- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_scanner_discovery.htm
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_pref_build_scanner_discovery.htm
@@ -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="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.
+ See also <a href="../concepts/cdt_c_scanner_discovery.htm">Scanner Discovery</a> - Console View.
</td>
</tr>
</tbody>

Back to the top