mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

Updated Scanner Config Discovery property page user documentation.

Browse source
This commit is contained in:
Vladimir Hirsl 2005-07-22 17:23:58 +00:00
parent 906b67ad17
commit ede231c47e
6 changed files with 196 additions and 108 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 15 KiB

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

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 32 KiB

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

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

157
doc/org.eclipse.cdt.doc.user/reference/cdt_u_sprop_mdiscovery.htm
View file

@ -1,64 +1,113 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//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>C/C++ Project Properties, Standard, Discovery Options</title>
<link rel="stylesheet" type="text/css" href="../help.css">
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>C/C++ Project Properties, Standard, Discovery Options</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<h1>C/C++ Project Properties, Standard, Discovery Options</h1>
<p>You can define the discovery options on the Discovery Options page of a C/C++ project's properties window.</p>
<p><img img src="../images/sprop_make_discovery.png" alt="C/C++ Project Properties, Standard, Discovery Options"></p>
<p>
<p>You can define the discovery options on the Discovery Options page
of a C/C++ project's properties window.<br>
</p>
<dl>
<dt>Automate scanner configuration discovery</dt>
<dd>Select this checkbox to configure the automatic discovery of paths and symbols.</dd>
<dt>Build output parser options</dt>
<dd>Monitors the output of the build to automatically keep the list of include paths and symbols up to date with the makefile.</dd>
<dt>Generate scanner info command options</dt>
<dd>This section allows you to select the scanner info settings.</dd>
<dt>Restore Defaults</dt><dd>Returns any changes back to their default setting.</dd>
<dt>Apply</dt><dd>Applies any changes.</dd>
</dl></p>
<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"><br>
<dt>Discovery profile</dt>
<dd>Select either per project or per file scanner info discovery
profile.</dd>
</dl>
<ul>
<li>Per project discovery profile</li>
</ul>
<p style="margin-left: 40px;"><img img=""
src="../images/sprop_make_discovery_project.png"
alt="C/C++ Project Properties, Standard, Discovery Options"
style="width: 598px; height: 585px;"><br>
</p>
<ul>
<li>Per file discovery profile<br>
</li>
</ul>
<p>
</p>
<dl>
</dl>
<div style="margin-left: 40px;"><img
alt="C/C++ Project Properties, Standard, Discovery Options"
src="../images/sprop_make_discovery_file.png"
style="width: 598px; height: 585px;"><br>
</div>
<dl>
<dt><br>
</dt>
<dt>Automate scanner configuration discovery</dt>
<dd>Select this checkbox to configure the automatic discovery of
paths and symbols.</dd>
<dt>Build output parser options</dt>
<dd>Monitors the output of the build to automatically keep the list
of include paths and symbols up to date with the makefile.</dd>
<dt>Load buildoutput from file</dt>
<dd>Run discovery of paths and symbols based on build output from a
file.<br>
</dd>
<dt>Generate scanner info command options</dt>
<dd>This section allows you to select a command to be used for
discovering compiler's internal scanner info.</dd>
<dt><br>
</dt>
<dt>Restore Defaults</dt>
<dd>Returns any changes back to their default setting.</dd>
<dt>Apply</dt>
<dd>Applies any changes.</dd>
</dl>
<p><img src="../images/ngref.gif" alt="Related reference" border="0"
height="21" width="143"><br>
<a href="cdt_u_sprop_info.htm">C++ Project Properties, Standard, Info</a><br>
<a href="cdt_u_sprop_builders.htm">C++ Project Properties, Standard, Builders</a><br>
<a href="cdt_u_sprop_file_types.htm">C++ Project Properties, Standard, File Types</a><br>
<a href="cdt_u_sprop_includes.htm">C++ Project Properties, Standard, Include Paths and Symbols</a><br>
<a href="cdt_u_sprop_indexer.htm">C++ Project Properties, Standard, Indexer</a><br>
<a href="cdt_u_sprop_mbuild.htm">C++ Project Properties, Standard, Make Builder</a><br>
<a href="cdt_u_sprop_merror.htm">C++ Project Properties, Standard, Error Parser</a><br>
<a href="cdt_u_sprop_mbinary.htm">C++ Project Properties, Standard, Binary Parser</a><br>
<a href="cdt_u_sprop_psource.htm">C++ Project Properties, Standard, Source</a><br>
<a href="cdt_u_sprop_poutput.htm">C++ Project Properties, Standard, Output</a><br>
<a href="cdt_u_sprop_pproj.htm">C++ Project Properties, Standard, Projects</a><br>
<a href="cdt_u_sprop_plib.htm">C++ Project Properties, Standard, Libraries</a><br>
<a href="cdt_u_sprop_pcontainers.htm">C++ Project Properties, Standard, Path Containers</a><br>
<a href="cdt_u_sprop_ref.htm">C++ Project Properties, Standard, Project References</a><br>
<a href="cdt_u_sprop_builders.htm">C++ Project Properties, Standard,
Builders</a><br>
<a href="cdt_u_sprop_file_types.htm">C++ Project Properties, Standard,
File Types</a><br>
<a href="cdt_u_sprop_includes.htm">C++ Project Properties, Standard,
Include Paths and Symbols</a><br>
<a href="cdt_u_sprop_indexer.htm">C++ Project Properties, Standard,
Indexer</a><br>
<a href="cdt_u_sprop_mbuild.htm">C++ Project Properties, Standard, Make
Builder</a><br>
<a href="cdt_u_sprop_merror.htm">C++ Project Properties, Standard,
Error Parser</a><br>
<a href="cdt_u_sprop_mbinary.htm">C++ Project Properties, Standard,
Binary Parser</a><br>
<a href="cdt_u_sprop_psource.htm">C++ Project Properties, Standard,
Source</a><br>
<a href="cdt_u_sprop_poutput.htm">C++ Project Properties, Standard,
Output</a><br>
<a href="cdt_u_sprop_pproj.htm">C++ Project Properties, Standard,
Projects</a><br>
<a href="cdt_u_sprop_plib.htm">C++ Project Properties, Standard,
Libraries</a><br>
<a href="cdt_u_sprop_pcontainers.htm">C++ Project Properties, Standard,
Path Containers</a><br>
<a href="cdt_u_sprop_ref.htm">C++ Project Properties, Standard, Project
References</a><br>
<a href="cdt_u_mprop_info.htm">C++ Project Properties, Managed, Info</a><br>
<a href="cdt_u_mprop_builders.htm">C++ Project Properties, Managed, Builders</a><br>
<a href="cdt_u_mprop_build.htm">C++ Project Properties, Managed, C/C++ Build</a><br>
<a href="cdt_u_mprop_tool_settings.htm">C++ Project Properties, Managed, C/C++ Build, Tool Settings</a><br>
<a href="cdt_u_mprop_build_settings.htm">C++ Project Properties, Managed, C/C++ Build, Build Settings</a><br>
<a href="cdt_u_mprop_merror.htm">C++ Project Properties, Managed, C/C++ Build, Error Parsers</a><br>
<a href="cdt_u_mprop_mbinary.htm">C++ Project Properties, Managed, C/C++ Build, Binary Parser</a><br>
<a href="cdt_u_mprop_file_types.htm">C++ Project Properties, Managed, File Types</a><br>
<a href="cdt_u_mprop_indexer.htm">C++ Project Properties, Managed, Indexer</a><br>
<a href="cdt_u_mprop_ref.htm">C++ Project Properties, Managed, Project References</a></p>
<img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" >
<a href="cdt_u_mprop_builders.htm">C++ Project Properties, Managed,
Builders</a><br>
<a href="cdt_u_mprop_build.htm">C++ Project Properties, Managed, C/C++
Build</a><br>
<a href="cdt_u_mprop_tool_settings.htm">C++ Project Properties,
Managed, C/C++ Build, Tool Settings</a><br>
<a href="cdt_u_mprop_build_settings.htm">C++ Project Properties,
Managed, C/C++ Build, Build Settings</a><br>
<a href="cdt_u_mprop_merror.htm">C++ Project Properties, Managed, C/C++
Build, Error Parsers</a><br>
<a href="cdt_u_mprop_mbinary.htm">C++ Project Properties, Managed,
C/C++ Build, Binary Parser</a><br>
<a href="cdt_u_mprop_file_types.htm">C++ Project Properties, Managed,
File Types</a><br>
<a href="cdt_u_mprop_indexer.htm">C++ Project Properties, Managed,
Indexer</a><br>
<a href="cdt_u_mprop_ref.htm">C++ Project Properties, Managed, Project
References</a></p>
<img src="../images/ng00_04a.gif" alt="IBM Copyright Statement">
</body>
</html>
</html>

73
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_discovery.htm
View file

@ -1,30 +1,59 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//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>Set Discovery Options</title>
<link rel="stylesheet" type="text/css" href="../help.css">
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Set Discovery Options</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<h1>Set Discovery Options</h1>
<p>For most standard make projects you will want to parse the output of the build to populate your paths and symbols tables. </p>
<p>To do so right click on your project and select <b>Properties &gt; C/C++ Make Project &gt; Discovery Options </b>
and select the <b>Automate discovery of paths and symbols</b> checkbox.</p>
<p><img img src="../images/sprop_make_discovery.png" alt="C/C++ Project Properties, Standard, Discovery Options"></p>
<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"><br>
<p>For most standard make projects you will want to parse the output of
the build to populate your paths and symbols tables. </p>
<p>To do so right click on your project and select <b>Properties &gt;
C/C++ Make Project &gt; Discovery Options </b>
and select the <b>Automate discovery of paths and symbols</b> checkbox.<br>
</p>
<p>There are two discovery profiles available:<br>
</p>
<ul>
<li>Per project - all discovered paths and symbols are associated
with the project; all files use this information. <br>
</li>
</ul>
<p style="margin-left: 40px;"><img img=""
src="../images/sprop_make_discovery_project.png"
alt="C/C++ Project Properties, Standard, Discovery Options"
style="width: 598px; height: 585px;"><br>
</p>
<ul>
<li>Per file - specific discovered paths and symbols are associated
with a file or set of files they apply to. Header files that do not
inherit information from a source file that includes it will use
project level information. Source files that have not been compiled at
all will have no information associated (high level CDT functionality
will be limited for these files).<br>
<br>
Use per file profile to improve CDT features correctness.<br>
<br>
</li>
</ul>
<p></p>
<div style="margin-left: 40px;"><img
alt="C/C++ Project Properties, Standard, Discovery Options"
src="../images/sprop_make_discovery_file.png"
style="width: 598px; height: 585px;"><br>
</div>
<p>For both profiles there is an option to discover paths and symbols
based on a previous build output. To activate the discovery select a
build log file and then the <span style="font-weight: bold;">Load</span>
button.<br>
</p>
<p><img src="../images/ngref.gif" alt="Related reference" border="0"
height="21" width="143"><br>
<a href="cdt_t_convert_cdt_proj.htm">Converting CDT 1.x Projects</a><br>
<a href="../reference/cdt_u_sprop_mdiscovery.htm">C/C++ Project Properties, Standard, Discovery Options</a></p>
<img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" >
<a href="../reference/cdt_u_sprop_mdiscovery.htm">C/C++ Project
Properties, Standard, Discovery Options</a></p>
<img src="../images/ng00_04a.gif" alt="IBM Copyright Statement">
</body>
</html>
</html>

74
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_proj_paths.htm
View file

@ -1,50 +1,60 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//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>Adding Include paths and symbols</title>
<link rel="stylesheet" type="text/css" href="../help.css">
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Adding Include paths and symbols</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<h1>Adding Include paths and symbols</h1>
<p>For Standard Make projects you can define include paths and preprocessor symbols for the parser.
This enables the parser to understand the contents of the C/C++ source
code so that you may more effectively use the search and code completion
features. </p>
<p>If Autodiscovery is enabled once a build has completed any discovered paths and symbols will be displayed in the Discoverd Paths section. You can also define the properties on a per project basis in the C/C++ Projects or Navigator views.</p>
<p>For Standard Make projects you can define include paths and
preprocessor symbols for the parser. This enables the parser to
understand the contents of the C/C++ source code so that you may more
effectively use the search and code completion features. </p>
<p>If Autodiscovery is enabled once a build has completed any
discovered paths and symbols will be displayed in the Discoverd Paths
section. You can also define the properties on a per project basis in
the C/C++ Projects or Navigator views.</p>
<p>To add include paths and symbols:</p>
<ol>
<li>To set properties for your project right click your standard make project and select <b>Properties</b>.
<li>To set properties for your project right click your standard make
project and select <b>Properties</b>. Alternatively, to set properties
for a specific source file in your project right click a source file
within your standard make project and select <span
style="font-weight: bold;">Properties</span>. </li>
<li>Click <b>C/C++ Include Paths and Symbols</b>.<br>
<img src="../images/c_paths_symbols.png" alt="Paths and Symbols Prefereces Window"><br>&nbsp;</li>
<img src="../images/c_paths_symbols.png"
alt="Paths and Symbols Prefereces Window"><br>
&nbsp;</li>
<li>Select <b>Add Preprocessor Symbol...</b><br>
<img src="../images/add_preprocessor_symbol.png" alt="Add Preprocessor Symbols Window"><br>
and enter your symbol.<br>&nbsp;</li>
<img src="../images/add_preprocessor_symbol.png"
alt="Add Preprocessor Symbols Window"><br>
and enter your symbol.<br>
&nbsp;</li>
<li>Select <b>Add External Include Path...</b><br>
<img src="../images/add_external_include_path.png" alt="Add External Include Path Window"><br>
and enter your path.<br>&nbsp;</li>
<li>Select the container and click <b>Edit</b> to change the order in which your new path or symbol is used.<br>
<img src="../images/c_path_symbols_edit.png" alt="Edit Paths and Symbols Container Window"><br>&nbsp;</li>
<li>Select the new object and click <b>Up</b> or <b>Down</b> to move it higher or lower in the order, or you can disable it by clicking <b>Disable</b>.</li>
<img src="../images/add_external_include_path.png"
alt="Add External Include Path Window"><br>
and enter your path.<br>
&nbsp;</li>
<li>Select the container and click <b>Edit</b> to change the order
in which your new path or symbol is used.<br>
<img src="../images/c_path_symbols_edit.png"
alt="Edit Paths and Symbols Container Window"><br>
&nbsp;</li>
<li>Select the new object and click <b>Up</b> or <b>Down</b> to
move it higher or lower in the order, or you can disable it by clicking
<b>Disable</b>.</li>
<li>Click <b>Finish</b> to close the Edit Container window.</li>
<li>Click <b>OK</b> to close the Preferences window.</li>
</ol>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"><br>
<p><img src="../images/ngconcepts.gif" alt="Related concepts" border="0"
height="21" width="143"><br>
<a href="../concepts/cdt_c_projects.htm">CDT Projects</a><br>
<a href="../concepts/cdt_c_proj_file_views.htm">Project file views</a></p>
<p><img border="0" src="../images/ngtasks.gif" ALT="Related tasks" width="143" height="21"><br>
<p><img src="../images/ngtasks.gif" alt="Related tasks" border="0"
height="21" width="143"><br>
<a href="cdt_o_proj_files.htm">Working with C/C++ project files</a></p>
<img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" >
<img src="../images/ng00_04a.gif" alt="IBM Copyright Statement">
</body>
</html>
</html>