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 index 25a6c3560f4..da31eae02d3 100644 --- a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm @@ -1,56 +1,77 @@ - - - -C/C++ Indexer - + + + C/C++ Indexer + - -

C/C++ Indexer

- -

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: +

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).

- -

Related concepts -
-C/C++ search
+ +

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).
+

+

CDT 3.0 supports the contribution of additional indexers, with 2 +indexers being provided with the default CDT release:
+

+ +

Related concepts
+Full C/C++ Indexer
+C/C++ search
C/C++ Indexer Problem Reporting
-C/C++ Indexer Opening or Closing a project
+C/C++ Indexer Opening or Closing +a project
C/C++ Indexer Progress Bar

- - -

Related tasks
-Selection Searching for C/C++ elements
-Enable/Disable the C/C++ Indexer
-C/C++ Indexer Problem Reporting
-C/C++ Indexer - Indexer Timeout
+

Related tasks
+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

- - -

Related reference -
Search, C/C++ Preferences window -
C/C++ search page, Search dialog box -
C/C++ Project Properties, Managed, Indexer -
C/C++ Project Properties, Standard, Indexer

- +

Related reference +
+Search, C/C++ Preferences +window +
+C/C++ search page, Search +dialog box +
+C/C++ Project +Properties, Managed, Indexer +
+C/C++ Project +Properties, Standard, Indexer

 

-IBM Copyright Statement - +IBM Copyright Statement - - \ No newline at end of file + diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_ctagsindexer.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_ctagsindexer.htm new file mode 100644 index 00000000000..f03d2c78b37 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_ctagsindexer.htm @@ -0,0 +1,64 @@ + + + + + + CTags Indexer + + + +

CTags Indexer

+

The CTags indexer makes use of Exuberant CTags (version 5.5.4) to +create an index of the source and header files in your project. The +main advantage provided by CTags is that the index creation is very +quick. This makes it ideal to use on larger sized projects. 
+

+

CTags, however, does not provide the same level of detail in +indexing as the Full C/C++ indexer. Specifically:
+

+ +

Related concepts
+Full C/C++ Indexer
+C/C++ search
+C/C++ Indexer Problem Reporting
+C/C++ Indexer Opening or Closing +a project
+C/C++ Indexer Progress Bar

+

Related tasks
+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
+

+

Related reference +
+Search, C/C++ Preferences +window +
+C/C++ search page, Search +dialog box +
+C/C++ Project +Properties, Managed, Indexer +
+C/C++ Project +Properties, Standard, Indexer

+

 

+IBM Copyright Statement + + diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_fullindexer.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_fullindexer.htm new file mode 100644 index 00000000000..be75141a5f3 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_fullindexer.htm @@ -0,0 +1,59 @@ + + + + + + Full C/C++ Indexer + + + +

Full C/C++ Indexer

+

The Full C/C++ Indexer is a new indexer for CDT 3.0 which makes use +of the new DOM. It creates a full index of the project's source +providing both declaration and cross reference information to the +various clients that make use of the index. In comparison with the +previous versions of the indexer, the new C/C++ indexer provides +quicker and more accurate results.
+

+

This indexer provides the most complete set of information but can +be potentially long running, especially on larger projects.
+

+

Related concepts
+C/C++ Indexer
+C/C++ search
+C/C++ Indexer Problem Reporting
+C/C++ Indexer Opening or Closing +a project
+C/C++ Indexer Progress Bar

+

Related tasks
+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
+

+

Related reference +
+Search, C/C++ Preferences +window +
+C/C++ search page, Search +dialog box +
+C/C++ Project +Properties, Managed, Indexer +
+C/C++ Project +Properties, Standard, Indexer

+

 

+IBM Copyright Statement + + diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_ctagsmissing.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_ctagsmissing.PNG new file mode 100644 index 00000000000..954733f754b Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_ctagsmissing.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_properties.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_properties.PNG new file mode 100644 index 00000000000..4c4798e6a9b Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_properties.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_wrongtagformat.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_wrongtagformat.PNG new file mode 100644 index 00000000000..28627c401e8 Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_wrongtagformat.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_fullindexer_properties.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_fullindexer_properties.PNG new file mode 100644 index 00000000000..8400fd9271f Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_fullindexer_properties.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG new file mode 100644 index 00000000000..d17b724d4a7 Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject2.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject2.PNG new file mode 100644 index 00000000000..484586410ba Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject2.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG new file mode 100644 index 00000000000..624253186d9 Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound_problemsview.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound_problemsview.PNG new file mode 100644 index 00000000000..555a7ca9049 Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound_problemsview.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG new file mode 100644 index 00000000000..7aa43429697 Binary files /dev/null and b/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG differ diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html new file mode 100644 index 00000000000..3e6638d8e9f --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html @@ -0,0 +1,38 @@ + + + + + + Indexer Preference Page + + + +

Indexer Preference Page

+

Indexer Preferences Window
+

+

The indexer preference page allows you to select which indexer is to +be used as a default for new projects.

+

Related concepts
+Coding aids
+C/C++ search

+

Related tasks
+Searching for C/C++ elements
+Customizing the C/C++ +editor

+

Related reference +
+C/C++ search page, Search window
+Search action
+Search view
+

+

Copyright
+

+

+

+ + diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html new file mode 100644 index 00000000000..712fae08169 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html @@ -0,0 +1,167 @@ + + + + + + Enable/Disable CTags Indexer + + + +

Enable/Disable CTags Indexer

+

Users can choose which indexer they wish to use on a specific +project by bringing up the project properties and
+selecting an indexer from the available indexer list.
+

+

CTags Indexer Properties

+

Enable CTags Indexer

+

Enabling the  indexer +

+To enable the CTags Indexer: +
    +
  1. Right click on the project and select Properties > C/C++ +Indexer
    2. +
  2. Select the CTags Indexer (declarations only) from the +list of available indexers
    +
    3. +
  3. Click OK
    4. +
+This will throw away whatever old index was around for the current +project and start a new reindex of the entire project using the CTags
+indexer and whatever options are present on the property page.
+

CTags Location
+

+By default, the CTags Indexer expects that Ctags has been added to the +path and will try to use it. To use another CTags:
+
+
    +
  1. Right click on the project and select Properties > C/C++ +Indexer
    2. +
  2. Click the Use the specified CTags button
    3. +
  3. Click on the Browse... +button
    4. +
  4. Navigate to the location of the desired CTags
    5. +
  5. Select the CTags executable and click Open
    6. +
+The path of  the given CTags executable is displayed in the CTags +location box. When indexing the current project from now
+on, the CTags indexer will now use whatever CTags is displayed on the +path.
+
+If the CTags indexer can't find the location of your CTags or can't use +the specified CTags it will let you know in the form
+of a warning marker.
+
+CTags missing
+

Include Files
+

+Checking this box will cause the CTags indexer to index all of the +files on the project's include paths.
+
+

CTags File
+

+By default, the CTags indexer runs CTags on your project and stores the +output in an internal file before adding the entries
+to the index. If you have an already existing CTag output file, you can +get import it into the index. To do this:
+
+
    +
  1. Right click on the project and select Properties > C/C++ +Indexer
    2. +
  2. Click the Import existing CTags +file button
    3. +
  3. Browse to the CTags location
    4. +
  4. Click OK
    5. +
  5. Close and reopen the +project
    +
    6. +
+The CTags Indexer will now attempt to import your CTags file.
+
+Note that the CTags indexer expects a certain format for the CTags +file. In order for an external file to be imported
+by the CTags indexer, the following conditions must be met:
+
    +
  1. Exuberant CTags version 5.5.4 was used
    2. +
  2. The following options are run with CTags:
    3. +
+ +
+If the CTags indexer cannot parse the given CTag file it will tell you +what the problem is in the form of a warning marker:
+
+CTag wrong format
+
+

Disable CTags Indexer

+
+To disable the CTags Indexer: +
    +
  1. Right click on the project and select Properties > C/C++ +Indexer
    2. +
  2. Select the No Indexer (search +based features will not work correctly)
    3. +
  3. Click OK
    4. +
+This will stop any ongoing indexes and disconnect the project from +reacting to resource changes.
+

Related concepts +
+C/C++ search
+C/C++ Indexer
+C/C++ Indexer Problem +Reporting
+C/C++ Indexer +Opening or Closing a project
+C/C++ Indexer Progress +Bar

+

Related tasks
+Selection Searching for C/C++ +elements
+Enable/Disable the C/C++ +Indexer
+C/C++ Indexer - Indexer +Timeout
+Setting Source Folders
+

+

Related reference +
+Search, C/C++ Preferences +window +
+C/C++ search page, Search +dialog box +
+C/C++ Project +Properties, Managed, Indexer +
+C/C++ Project +Properties, Standard, Indexer

+

 

+IBM Copyright Statement + + +
+
+ + diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm new file mode 100644 index 00000000000..094cb54faa1 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm @@ -0,0 +1,121 @@ + + + + + + Enable/Disable Full C/C++ Indexer + + + +

Enable/Disable Full C/C++ Indexer

+

Users can choose which indexer they wish to use on a specific +project by bringing up the project properties and
+selecting an indexer from the available indexer list.
+

+

Full C/C++ Indexer Properties

+

Enable Full C/C++ Indexer

+

Build Info

+
+In order for the Full C/C++ Indexer to successfully index your project, +it is necessary to set up your project's build info.
+This build info is used by the parser to find the paths specified +within your source files. Note that without +any build info,
+the full C/C++ indexer will just skip +over all files.
+
+For Managed Make projects, +some build info is provided by default when a project gets first +created. This default info is
+enough to allow the indexer to index the entire project. However, it is +possible that some internal include paths could still be
+missing. In this case a warning marker will appear next to the +inclusion that was not found and a corresponding entry will appear
+in the Problems view.
+
+Preprocessor inclusion not found
+
+
+Inclusion Problems View
+
+For Standard Make projects, no +build info is provided by default. However, if you rebuild your project +the Scanner Discovery will
+kick in - regardless if you have an actual makefile -  and +populate some default build info. For more information see the Set Discovery
+Options page.
+
+For both types of projects you can always add build paths manually by +right clicking on the project properties.
+

Enabling the  indexer

+
+To enable the Full C/C++ Indexer: +
    +
  1. Right click on the project and select Properties > C/C++ +Indexer
    2. +
  2. Select the Full C/C++ Indexer (declarations and cross +references)
    3. +
  3. Click OK
    4. +
+This will throw away whatever old index was around for the current +project and start a new reindex of the entire project using the full
+C/C++ Indexer.
+
+

Disable Full C/C++ Indexer

+
+To disable the Full C/C++ Indexer: +
    +
  1. Right click on the project and select Properties > C/C++ +Indexer
    2. +
  2. Select the No Indexer (search +based features will not work correctly)
    3. +
  3. Click OK
    4. +
+This will stop any ongoing indexes and disconnect the project from +reacting to resource changes.
+

Related concepts +
+C/C++ search
+C/C++ Indexer
+C/C++ Indexer Problem +Reporting
+C/C++ Indexer +Opening or Closing a project
+C/C++ Indexer Progress +Bar

+

Related tasks
+Selection Searching for C/C++ +elements
+Enable/Disable the C/C++ +Indexer
+C/C++ Indexer - Indexer +Timeout
+Setting Source Folders
+

+

Related reference +
+Search, C/C++ Preferences +window +
+C/C++ search page, Search +dialog box +
+C/C++ Project +Properties, Managed, Indexer +
+C/C++ Project +Properties, Standard, Indexer

+

 

+IBM Copyright Statement + + diff --git a/doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html b/doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html new file mode 100644 index 00000000000..340396be5a5 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html @@ -0,0 +1,106 @@ + + + + + + Indexing a large project + + + +

Indexing a large project
+

+

Although any indexer can be used to index an existing project at any +time, the following steps present a recommended
+approach to importing large projects.
+

+ + +

    Import project setup

+ + + +Null Indexer
+ +
+ + + +
+By following these steps, you are making sure that the time spent +indexing will produce meaningful results.
+

Related concepts +
+C/C++ search
+C/C++ Indexer
+C/C++ Indexer Problem +Reporting
+C/C++ Indexer +Opening or Closing a project
+C/C++ Indexer Progress +Bar

+

Related tasks
+Selection Searching for C/C++ +elements
+Enable/Disable the C/C++ +Indexer
+C/C++ Indexer - Indexer +Timeout
+Setting Source Folders
+

+

Related reference +
+Search, C/C++ Preferences +window +
+C/C++ search page, Search +dialog box +
+C/C++ Project +Properties, Managed, Indexer +
+C/C++ Project +Properties, Standard, Indexer

+

 

+IBM Copyright Statement + + +
+
+ +