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

+ +

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
+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_open_close.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_open_close.htm new file mode 100644 index 00000000000..46199580e2e --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_open_close.htm @@ -0,0 +1,49 @@ + + + + + + +C/C++ Indexer Opening or Closing a project + + + + + +

C/C++ Indexer Opening or Closing a project

+ +

The user opening a previously closed project results in the entire project being re-indexed.

+ +

Closing a project results in the index being deleted.

+ + + +

Related concepts +
+C/C++ search
+C/C++ Indexer
+C/C++ Indexer Problem Reporting
+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_prob_rep.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_prob_rep.htm new file mode 100644 index 00000000000..960e337939b --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_prob_rep.htm @@ -0,0 +1,74 @@ + + + + + + +C/C++ Indexer Problem Reporting + + + + + +

C/C++ Indexer Problem Reporting

+ +

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.

+ +

Preprocessor Problems

+

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

+ +

Semantic Problems

+ +

The problem markers can also indicate semantic errors in your code.

+

The errors flagged include: +

+ + + +

Related concepts +
+C/C++ search
+C/C++ Indexer
+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_prog_bar.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_prog_bar.htm new file mode 100644 index 00000000000..98c686c3e51 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_prog_bar.htm @@ -0,0 +1,51 @@ + + + + + + +C/C++ Indexer Progress Bar + + + + + +

C/C++ Indexer Progress Bar

+ +

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.

+ +

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

+ + +

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_search.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_search.htm index c39ee4259ba..eaaa70d4a93 100644 --- a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_search.htm +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_search.htm @@ -19,10 +19,16 @@ through the use of search delimiters, correct syntax, and wildcards.

You can search for:

@@ -110,8 +116,8 @@ is to be searched:

  • Workspace
  • Working Set
  • Selected Resources
  • -
  • Project
  • +

    Wildcard characters

    You can use wildcard characters to further refine your search.

    @@ -213,8 +219,8 @@ your last search.

  • Workbench User Guide > Concepts > Views > Search view
  • Workbench User Guide > Tasks > Navigating and finding resources
  • -

    Related concepts -
    +

    Related concepts
    +C/C++ Indexer
    CDT Projects
    Open Declarations

    Related tasks diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_search_ext.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_search_ext.htm new file mode 100644 index 00000000000..b3c0e8f8ea6 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_search_ext.htm @@ -0,0 +1,37 @@ + + + + + + +Searching External Files + + + + + +

    Searching External Files

    + +

    C/C++ search, by default, will only search your workspace. +If you wish to search external files that are included by files in your workspace but don’t reside in your workspace, +you must enable external search markers.

    + +

    When a match in an external file is now found, it will be linked into your project and you will be able to open the match from the search pane as usual.

    + +

    When a project is closed, or the workbench is shutdown the links are removed.

    + +

    Related concepts +
    C/C++ search

    + +

    Related tasks +
    Searching External Files + +

    Related reference +
    Search, C/C++ Preferences window +
    C/C++ search page, Search dialog box

    +

     

    +IBM Copyright Statement + + + + diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_o_concepts.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_o_concepts.htm index 9fedb5e7825..7946405c0c0 100644 --- a/doc/org.eclipse.cdt.doc.user/concepts/cdt_o_concepts.htm +++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_o_concepts.htm @@ -31,7 +31,6 @@ Outline View
    Project File views
    Make Targets View
    - C/C++ search
    Open declaration
    Open Type
    Class Browser
    @@ -46,6 +45,12 @@ Breakpoints
    Debug overview
    Debug information
    +C/C++ search
    + C/C++ Indexer
    + C/C++ Indexer Problem Reporting
    + C/C++ Indexer Opening or Closing a project
    + C/C++ Indexer Progress Bar
    + Searching External Files

    IBM Corporation Statement

    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

    IBM Copyright Statement

    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 @@ + + + + + + +Enable/Disable the C/C++ Indexer + + + + + +

    Enable/Disable the C/C++ Indexer

    + +

    The C/C++ indexer is on by default. You can enable/disable indexing on any project from the C/C++ perspective.

    +

    C/C++ Indexer Properties

    + +

    The indexer can be enabled or disabled at any time by: + +

      +
    1. Right clicking on the project
    2. +
    3. Selecting Properties
    4. +
    5. Navigate to the C/C++ Indexer page
    6. +
    7. Select/Deselect the Enable C/C++ Indexing checkbox.
    8. +

    + +

    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.

    + +

    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
    +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/tasks/cdt_t_indexer_prob_rep.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_prob_rep.htm new file mode 100644 index 00000000000..89ba714a806 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_prob_rep.htm @@ -0,0 +1,53 @@ + + + + + + +C/C++ Indexer Problem Reporting + + + + + +

    C/C++ Indexer Problem Reporting

    + +

    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.

    +

    C/C++ Indexer Properties

    +

    To enable C/C++ Index Problem reporting: +

      +
    1. Right click on the project and select Properties > C/C++ Indexer
    2. +
    3. Select the Enable C/C++ Index problem reporting checkbox
    4. +
    5. Click OK
    6. +

    + + +

    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_timeout.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_timeout.htm new file mode 100644 index 00000000000..cba3d0e356c --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_timeout.htm @@ -0,0 +1,53 @@ + + + + + + +C/C++ Indexer – Indexer Timeout + + + + + +

    C/C++ Indexer – Indexer Timeout

    + +

    If the indexer gets stuck on a particular file while indexing there is a timeout watchdog, which will terminate the indexing attempt after a certain period.

    +

    C/C++ Search Preferences

    +

    This can be set as follows: +

      +
    1. Click Windows > Preferences > C/C++ > Search
    2. +
    3. Enter the timeout value in milliseconds into the text field.
    4. +
    5. Click OK
    6. +

    + + +

    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 Problem Reporting
    +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_manualbuild.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_manualbuild.htm index 2e7963f70fa..a9dc7d87db9 100644 --- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_manualbuild.htm +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_manualbuild.htm @@ -15,7 +15,7 @@

    Manual builds let you choose the scope of a build, as well as options for building, or rebuilding projects. You can view the output of the make utility in the console.

    -

    Sample build in console veiw

    +

    Sample build in console view

    diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search.htm index 1608f1689bd..5cc137c9717 100644 --- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search.htm +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search.htm @@ -63,11 +63,14 @@ include paths and symbols are correctly defined. For more information, see

    Related concepts
    C/C++ search
    +C/C++ Indexer
    CDT Projects
    Open Declarations

    +

    Related tasks
    Selection Searching for C/C++ elements
    Navigate to C/C++ declarations

    +

    Related reference
    C/C++ search page, Search dialog box

    diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search_ext.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search_ext.htm new file mode 100644 index 00000000000..796aacafd11 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search_ext.htm @@ -0,0 +1,44 @@ + + + + + + +Searching External Files + + + + + +

    Searching External Files

    + +

    C/C++ search, by default, will only search your workspace. +If you wish to search external files that are included by files in your workspace but don’t reside in your workspace, +you must enable external search markers.

    +

    C/C++ Search Preferences

    +To do this: +
      +
    1. Click Windows > Preferences > C/C++ > Search
    2. +
    3. Select the Enable external search markers checkbox.
    4. +
    5. Click OK
    6. +

    + + +

    When a match in an external file is now found, it will be linked into your project and you will be able to open the match from the search pane as usual.

    + +

    When a project is closed, or the workbench is shutdown the links are removed.

    + +

    Related concepts +
    Searching External Files +
    C/C++ search

    + + +

    Related reference +
    Search, C/C++ Preferences window +
    C/C++ search page, Search dialog box

    +

     

    +IBM Copyright Statement + + + + diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_set_src_fold.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_set_src_fold.htm new file mode 100644 index 00000000000..d6642df1a2b --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_set_src_fold.htm @@ -0,0 +1,69 @@ + + + + + + +Setting Source Folders + + + + + +

    Setting Source Folders

    + +

    Note that source folders can only be currently used with Standard Make projects. + Managed Make projects treat the entire project as a source folder.

    + +

    Source folders are a way to cut down on a project’s indexing scope. +You can mark the folders that are part of your day to day work or part of a subsystem that you work on. +All files inside source folders will be indexed and are, thus, searchable. +Note that any files pulled in by a file inside a source folder will also be indexed.

    +

    Set source folder

    + + +

    To setup source folders: +

      +
    1. Right click on the project and select Properties > C/C++ Project Paths
    2. +
    3. Click on the Source tab
      + By default the entire project is a source folder, which means everything will be indexed. + This is reasonable for smaller projects but definitely not recommended for large projects.
    4. +
    5. Click Add folder to add the folders. + A dialog will explain exclusion filters have been added to nesting folders. + You will see that the folder you added will be excluded from the project folder (in order to avoid including a folder twice). + Repeat until all the folders have been added.
      + Note: Don't forget to remove the project folder (which appears by default) otherwise everything will be indexed.
    6. +
    7. Click OK. Your view in C/C++ projects will now change. + You should see your source folders designated with a "C" and all other source and header files icons that are in a non-source folder will change to a "hollow" C or H.
    8. +
    + + + +

    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 Problem Reporting
    +C/C++ Indexer - Indexer Timeout

    + + +

    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 + + + + \ No newline at end of file diff --git a/doc/org.eclipse.cdt.doc.user/topics_Concepts.xml b/doc/org.eclipse.cdt.doc.user/topics_Concepts.xml index cd9106abfbd..2b03cf0ddd4 100644 --- a/doc/org.eclipse.cdt.doc.user/topics_Concepts.xml +++ b/doc/org.eclipse.cdt.doc.user/topics_Concepts.xml @@ -18,7 +18,6 @@ - @@ -30,4 +29,11 @@ + + + + + + + \ No newline at end of file diff --git a/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml b/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml index 18555b94b4b..85ef1268528 100644 --- a/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml +++ b/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml @@ -23,7 +23,6 @@ - @@ -75,6 +74,11 @@ - - + + + + + + +