Skip to content

Remove pre-built indexes for Eclipse Help system#382

Merged
MatthewKhouzam merged 1 commit intoeclipse-tracecompass:masterfrom
jonahgraham:indexes
Mar 12, 2026
Merged

Remove pre-built indexes for Eclipse Help system#382
MatthewKhouzam merged 1 commit intoeclipse-tracecompass:masterfrom
jonahgraham:indexes

Conversation

@jonahgraham
Copy link
Contributor

@jonahgraham jonahgraham commented Mar 11, 2026

What it does

This change fixes errors when doing a Help -> Contents and then initiating a search.

Errors such as:

!ENTRY org.eclipse.help.base 2 0 2026-03-11 13:55:32.290
!MESSAGE Unable to consume Lucene index from bundle 'org.eclipse.tracecompass.doc.user_11.2.0.202512122003 [236]'. The index should be rebuilt with Lucene 10.3.2

or

!ENTRY org.eclipse.help.base 4 0 2026-03-11 14:34:35.767
!MESSAGE Help index declared, but missing for plugin org.eclipse.tracecompass.incubator.ros2.doc.user.

The latter error generally happens for the incubator because the skeleton included building the index, but the build.properties was missing the the index/ entry, so they were not included in built bundles.

See eclipse-simrel/simrel.build#1288

How to test

  1. Build the bundles (with maven) and install them into Eclipse or start the RCP app.
  2. From Help -> Contents start a search
  3. Check the error log to make sure that no index errors are displayed - you should also see indexing message in the help:
image

Follow-ups

Review checklist

  • As an author, I have thoroughly tested my changes and carefully followed the instructions in this template

Summary by CodeRabbit

  • Chores
    • Removed help documentation search index generation from build process across all documentation modules.

This change fixes errors when doing a Help -> Contents and then
initiating a search.

Errors such as:

```
!ENTRY org.eclipse.help.base 2 0 2026-03-11 13:55:32.290
!MESSAGE Unable to consume Lucene index from bundle 'org.eclipse.tracecompass.doc.user_11.2.0.202512122003 [236]'. The index should be rebuilt with Lucene 10.3.2
```

or

```
!ENTRY org.eclipse.help.base 4 0 2026-03-11 14:34:35.767
!MESSAGE Help index declared, but missing for plugin org.eclipse.tracecompass.incubator.ros2.doc.user.
```

The latter error generally happens for the incubator because the
skeleton included building the index, but the build.properties
was missing the the `index/` entry, so they were not included in
built bundles.

See eclipse-simrel/simrel.build#1288
@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e312a9f1-7188-4ab4-b9eb-994b4e699226

📥 Commits

Reviewing files that changed from the base of the PR and between 1243012 and 772dda8.

📒 Files selected for processing (25)
  • doc/org.eclipse.tracecompass.analysis.profiling.doc.user/build.properties
  • doc/org.eclipse.tracecompass.analysis.profiling.doc.user/build.xml
  • doc/org.eclipse.tracecompass.analysis.profiling.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.analysis.profiling.doc.user/pom.xml
  • doc/org.eclipse.tracecompass.doc.dev/build.properties
  • doc/org.eclipse.tracecompass.doc.dev/build.xml
  • doc/org.eclipse.tracecompass.doc.dev/plugin.xml
  • doc/org.eclipse.tracecompass.doc.dev/pom.xml
  • doc/org.eclipse.tracecompass.doc.user/build.properties
  • doc/org.eclipse.tracecompass.doc.user/build.xml
  • doc/org.eclipse.tracecompass.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.doc.user/pom.xml
  • doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.properties
  • doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml
  • doc/org.eclipse.tracecompass.gdbtrace.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.gdbtrace.doc.user/pom.xml
  • doc/org.eclipse.tracecompass.rcp.doc.user/build.properties
  • doc/org.eclipse.tracecompass.rcp.doc.user/build.xml
  • doc/org.eclipse.tracecompass.rcp.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.rcp.doc.user/pom.xml
  • doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.properties
  • doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml
  • doc/org.eclipse.tracecompass.tmf.pcap.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.tmf.pcap.doc.user/pom.xml
  • pom.xml
💤 Files with no reviewable changes (19)
  • doc/org.eclipse.tracecompass.rcp.doc.user/build.xml
  • doc/org.eclipse.tracecompass.doc.dev/build.xml
  • pom.xml
  • doc/org.eclipse.tracecompass.analysis.profiling.doc.user/build.xml
  • doc/org.eclipse.tracecompass.rcp.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.doc.user/build.xml
  • doc/org.eclipse.tracecompass.analysis.profiling.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml
  • doc/org.eclipse.tracecompass.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.doc.dev/plugin.xml
  • doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml
  • doc/org.eclipse.tracecompass.doc.dev/pom.xml
  • doc/org.eclipse.tracecompass.tmf.pcap.doc.user/pom.xml
  • doc/org.eclipse.tracecompass.tmf.pcap.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.rcp.doc.user/pom.xml
  • doc/org.eclipse.tracecompass.gdbtrace.doc.user/pom.xml
  • doc/org.eclipse.tracecompass.gdbtrace.doc.user/plugin.xml
  • doc/org.eclipse.tracecompass.analysis.profiling.doc.user/pom.xml
  • doc/org.eclipse.tracecompass.doc.user/pom.xml

📝 Walkthrough

Walkthrough

This pull request systematically removes help index generation from eight Eclipse Trace Compass documentation modules. The changes eliminate index-related entries from build properties, Ant build files, plugin manifests, and Maven build configurations across the project, plus removes the root-level help documentation Eclipse run repository property.

Changes

Cohort / File(s) Summary
Build Properties
doc/org.eclipse.tracecompass.analysis.profiling.doc.user/build.properties, doc/org.eclipse.tracecompass.doc.dev/build.properties, doc/org.eclipse.tracecompass.doc.user/build.properties, doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.properties, doc/org.eclipse.tracecompass.rcp.doc.user/build.properties, doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.properties
Removed index/ from bin.includes across all documentation modules while retaining doc/ and other directory references.
Build XML Targets
doc/org.eclipse.tracecompass.*/build.xml (6 modules)
Removed build.index Ant target that invoked help.buildHelpIndex task, eliminating automated search index generation during builds.
Plugin Manifests
doc/org.eclipse.tracecompass.*/plugin.xml (6 modules)
Removed <index path="index/"> element from org.eclipse.help.toc extension points in all documentation plugin manifests.
Module Maven Build Files
doc/org.eclipse.tracecompass.analysis.profiling.doc.user/pom.xml, doc/org.eclipse.tracecompass.doc.dev/pom.xml, doc/org.eclipse.tracecompass.doc.user/pom.xml, doc/org.eclipse.tracecompass.gdbtrace.doc.user/pom.xml, doc/org.eclipse.tracecompass.rcp.doc.user/pom.xml, doc/org.eclipse.tracecompass.tmf.pcap.doc.user/pom.xml
Removed tycho-eclipserun-plugin configuration (for building help index via Ant) and maven-clean-plugin execution with id clean-index (for cleaning index directory).
Root Maven Build File
pom.xml
Removed help-docs-eclipserun-repo property and the parent tycho-eclipserun-plugin block including repositories and eclipse-run execution configuration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • bhufmann

Poem

🐰✨ Away with the indexes we go,
No need for help indices to slow our flow,
Six modules cleaned, one root made neat,
The build grows lighter, documentation's sweet! 📚

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Remove pre-built indexes for Eclipse Help system' directly and clearly describes the main objective of the PR, which is to remove pre-built Lucene indexes from documentation bundles across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@MatthewKhouzam MatthewKhouzam merged commit d2fde0d into eclipse-tracecompass:master Mar 12, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants