diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm new file mode 100644 index 00000000000..c616560ed75 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm @@ -0,0 +1,56 @@ + + + +
+ + +The C/C++ indexer uses the parser to create a database of your source and header files that provides the basis for C/C++ search, navigation features and parts of content assist.
+ +The indexer runs on a background thread and reacts to resource change events such as: +
It is possible to customize the behavior of the indexer through the use of source folders or even turn it off completely. +This customizable behavior is available on a per-project basis (i.e. it is possible to have different indexer settings for each project in your workspace).
+ +
+
+C/C++ search
+C/C++ Indexer Problem Reporting
+C/C++ Indexer Opening or Closing a project
+C/C++ Indexer Progress Bar
+Selection Searching for C/C++ elements
+Enable/Disable the C/C++ Indexer
+C/C++ Indexer Problem Reporting
+C/C++ Indexer - Indexer Timeout
+Setting Source Folders
+
+
Search, C/C++ Preferences window
+
C/C++ search page, Search dialog box
+
C/C++ Project Properties, Managed, Indexer
+
C/C++ Project Properties, Standard, Indexer
+
The user opening a previously closed project results in the entire project being re-indexed.
+ +Closing a project results in the index being deleted.
+ + + +
+
+C/C++ search
+C/C++ Indexer
+C/C++ Indexer Problem Reporting
+C/C++ Indexer Progress Bar
+Selection Searching for C/C++ elements
+Enable/Disable the C/C++ Indexer
+C/C++ Indexer Problem Reporting
+C/C++ Indexer – Indexer Timeout
+Setting Source Folders
+
+
Search, C/C++ Preferences window
+
C/C++ search page, Search dialog box
+
C/C++ Project Properties, Managed, Indexer
+
C/C++ Project Properties, Standard, Indexer
+
C/C++ Index Problem reporting places a problem marker on the editor and adds an item to the error list for each preprocessor or semantic problem reported by the parser. Note that the markers will only show up the next time the file is indexed.
+ +In order for search and search related features to work properly, it is imperative that include paths are set up properly so that the parser can find source files and index them. +If you suspect that your search results are lacking, you can turn on the preprocessor problem markers. These will place a marker on the line that has the preprocessor problem.
+This includes: +
The problem markers can also indicate semantic errors in your code.
+The errors flagged include: +
+
+C/C++ search
+C/C++ Indexer
+C/C++ Indexer Opening or Closing a project
+C/C++ Indexer Progress Bar
+Selection Searching for C/C++ elements
+Enable/Disable the C/C++ Indexer
+C/C++ Indexer Problem Reporting
+C/C++ Indexer - Indexer Timeout
+Setting Source Folders
+
+
Search, C/C++ Preferences window
+
C/C++ search page, Search dialog box
+
C/C++ Project Properties, Managed, Indexer
+
C/C++ Project Properties, Standard, Indexer
+
The indexer progress bar shows the progress status of the indexing jobs in the progress views.
+ +The indexing jobs can be temporarily paused by pressing the stop button on the progress bar. +This will cause the indexer to wait until the next time the user runs a search job or makes a change to an indexed element +(by such actions as modifying an existing source file, deleting a file, creating a new file, moving file and so on). +The indexer at this point will resume with the previously postponed indexing job before moving on to the new one.
+ +If you wish to cease indexing all together, you can cancel an indexing job and disable the indexer.
+ +
+
+C/C++ search
+C/C++ Indexer
+C/C++ Indexer Problem Reporting
+C/C++ Indexer Opening or Closing a project
+Selection Searching for C/C++ elements
+Enable/Disable the C/C++ Indexer
+C/C++ Indexer Problem Reporting
+C/C++ Indexer - Indexer Timeout
+Setting Source Folders
+
+
Search, C/C++ Preferences window
+
C/C++ search page, Search dialog box
+
C/C++ Project Properties, Managed, Indexer
+
C/C++ Project Properties, Standard, Indexer
+
You can search for:
You can use wildcard characters to further refine your search.
The C/C++ indexer is on by default. You can enable/disable indexing on any project from the C/C++ perspective.
+The indexer can be enabled or disabled at any time by: + +
If you enable the index on a project that had the index disabled, the indexer will reindex all of the project’s source folders.
+ +If you disable the index on a project, it will no longer react to any resource change events. If the indexer is indexing at the time you disable the index, it will throw away the rest of the index jobs at that point.
+ +If some projects in your workspace have the indexer disabled, then search will display a warning message in the status bar. If all projects have the index disabled then Search will not allow you to continue until at least one project has the index enabled.
+ +You can also disable the indexer when you first create a new project by clicking on the C/C++ Indexer tab (which is present in both Standard and Managed project wizards) and deselecting the Enable C/C++ Indexing checkbox.
+ +
+
+C/C++ search
+C/C++ Indexer
+C/C++ Indexer Problem Reporting
+C/C++ Indexer Opening or Closing a project
+C/C++ Indexer Progress Bar
+Selection Searching for C/C++ elements
+C/C++ Indexer Problem Reporting
+C/C++ Indexer - Indexer Timeout
+Setting Source Folders
+
+
Search, C/C++ Preferences window
+
C/C++ search page, Search dialog box
+
C/C++ Project Properties, Managed, Indexer
+
C/C++ Project Properties, Standard, Indexer
+
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_properties_indexer.png b/doc/org.eclipse.cdt.doc.user/images/cdt_properties_indexer.png
new file mode 100644
index 00000000000..87504fb955f
Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/cdt_properties_indexer.png differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_set_src_folder.png b/doc/org.eclipse.cdt.doc.user/images/cdt_set_src_folder.png
new file mode 100644
index 00000000000..44f75897e11
Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/cdt_set_src_folder.png differ
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm
index d89f419e077..823998864f6 100644
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm
@@ -76,6 +76,12 @@
Adding expressions
Working with registers
Working with memory
+Searching for C/C++ elements
+ Searching External Files
+ Enable/Disable the C/C++ Indexer
+ C/C++ Indexer Problem Reporting
+ C/C++ Indexer - Indexer Timeout
+ Setting Source Folders
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_endis_indexer.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_endis_indexer.htm new file mode 100644 index 00000000000..ee850746f66 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_endis_indexer.htm @@ -0,0 +1,63 @@ + + + +
+ + +
+ + + +
+ +