Remove pre-built indexes for Eclipse Help system#264
Merged
MatthewKhouzam merged 1 commit intoeclipse-tracecompass-incubator:masterfrom Mar 11, 2026
Merged
Remove pre-built indexes for Eclipse Help system#264MatthewKhouzam merged 1 commit intoeclipse-tracecompass-incubator:masterfrom
MatthewKhouzam merged 1 commit intoeclipse-tracecompass-incubator:masterfrom
Conversation
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
📝 WalkthroughWalkthroughThis change removes help index building functionality from Trace Compass documentation modules across the project. The modification deletes Ant build targets named Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
MatthewKhouzam
approved these changes
Mar 11, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
doc/org.eclipse.tracecompass.incubator.inandout.doc.user/.externalToolBuilders/Trace Compass Incubator User Guide Builder.launch (1)
4-4: Sync this builder with the in-and-out doc bundle.Removing
indexhere is fine, but this launch config still points at/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xmlon Lines 7-9 and Line 18, and the project id on Line 16 does not match this bundle’s path. As committed, invoking this external builder will still target the wrong doc plugin.Proposed fix
-<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:<?xml version="1.0" encoding="UTF-8"?> <resources> <item path="/org.eclipse.tracecompass.tmf.pcap.doc.user" type="4"/> </resources>}"/> +<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:<?xml version="1.0" encoding="UTF-8"?> <resources> <item path="/org.eclipse.tracecompass.incubator.inandout.doc.user" type="4"/> </resources>}"/> <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS"> -<listEntry value="/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml"/> +<listEntry value="/org.eclipse.tracecompass.incubator.inandout.doc.user/build.xml"/> </listAttribute> -<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.eclipse.tracecompass.incubator.inandoutdoc.user"/> +<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.eclipse.tracecompass.incubator.inandout.doc.user"/> -<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml}"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/org.eclipse.tracecompass.incubator.inandout.doc.user/build.xml}"/>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@doc/org.eclipse.tracecompass.incubator.inandout.doc.user/.externalToolBuilders/Trace` Compass Incubator User Guide Builder.launch at line 4, The launch configuration still references the wrong doc bundle and project: update the ANT build file path and project id entries in this launch config so they point to this bundle’s build.xml (replace the /org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml references) and set the project id to this bundle’s id, and if you removed the index target ensure org.eclipse.ant.ui.ATTR_ANT_MANUAL_TARGETS only lists the intended targets (e.g., "build") so the external builder runs against the correct doc plugin.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In
`@doc/org.eclipse.tracecompass.incubator.inandout.doc.user/.externalToolBuilders/Trace`
Compass Incubator User Guide Builder.launch:
- Line 4: The launch configuration still references the wrong doc bundle and
project: update the ANT build file path and project id entries in this launch
config so they point to this bundle’s build.xml (replace the
/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml references) and set the
project id to this bundle’s id, and if you removed the index target ensure
org.eclipse.ant.ui.ATTR_ANT_MANUAL_TARGETS only lists the intended targets
(e.g., "build") so the external builder runs against the correct doc plugin.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a2ce0dd7-9f17-410f-9440-88299413db2e
📒 Files selected for processing (66)
doc/org.eclipse.tracecompass.incubator.atrace.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.atrace.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.atrace.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.eventfieldcount.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.eventfieldcount.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.eventfieldcount.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.executioncomparison.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.executioncomparison.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.executioncomparison.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.filters.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.filters.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.filters.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.ftrace.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.ftrace.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.ftrace.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.gerrit.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.gerrit.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.gerrit.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.gpu.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.gpu.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.gpu.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.inandout.doc.user/.externalToolBuilders/Trace Compass Incubator User Guide Builder.launchdoc/org.eclipse.tracecompass.incubator.inandout.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.inandout.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.inandout.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.kernel.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.kernel.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.kernel.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.lttng2.ust.extras.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.lttng2.ust.extras.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.lttng2.ust.extras.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.opentracing.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.opentracing.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.opentracing.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.otf2.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.otf2.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.otf2.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.perf.profiling.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.perf.profiling.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.perf.profiling.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.ros.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.ros.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.ros.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.ros2.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.ros2.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.ros2.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.scripting.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.scripting.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.scripting.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.system.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.system.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.system.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.trace.server.doc.dev/build.xmldoc/org.eclipse.tracecompass.incubator.trace.server.doc.dev/plugin.xmldoc/org.eclipse.tracecompass.incubator.trace.server.doc.dev/pom.xmldoc/org.eclipse.tracecompass.incubator.uftrace.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.uftrace.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.uftrace.doc.user/pom.xmldoc/org.eclipse.tracecompass.incubator.virtual.machine.analysis.doc.user/build.xmldoc/org.eclipse.tracecompass.incubator.virtual.machine.analysis.doc.user/plugin.xmldoc/org.eclipse.tracecompass.incubator.virtual.machine.analysis.doc.user/pom.xmlpom.xmlskeleton/skeleton.doc.user/build.xmlskeleton/skeleton.doc.user/plugin.xmlskeleton/skeleton.doc.user/pom.xmlskeleton/skeleton.rcp/skeleton.tracecompass.parent/pom.xml
💤 Files with no reviewable changes (65)
- doc/org.eclipse.tracecompass.incubator.kernel.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.kernel.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.ros2.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.atrace.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.inandout.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.eventfieldcount.doc.user/build.xml
- skeleton/skeleton.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.executioncomparison.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.scripting.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.eventfieldcount.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.opentracing.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.opentracing.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.gerrit.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.ros.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.filters.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.lttng2.ust.extras.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.virtual.machine.analysis.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.lttng2.ust.extras.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.gerrit.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.virtual.machine.analysis.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.gpu.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.eventfieldcount.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.ftrace.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.ros2.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.uftrace.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.opentracing.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.gerrit.doc.user/pom.xml
- skeleton/skeleton.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.trace.server.doc.dev/plugin.xml
- doc/org.eclipse.tracecompass.incubator.virtual.machine.analysis.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.uftrace.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.ros.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.filters.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.trace.server.doc.dev/build.xml
- doc/org.eclipse.tracecompass.incubator.filters.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.executioncomparison.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.system.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.inandout.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.ros2.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.atrace.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.uftrace.doc.user/plugin.xml
- pom.xml
- doc/org.eclipse.tracecompass.incubator.ftrace.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.gpu.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.system.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.otf2.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.otf2.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.perf.profiling.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.otf2.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.ros.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.system.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.inandout.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.kernel.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.trace.server.doc.dev/pom.xml
- doc/org.eclipse.tracecompass.incubator.atrace.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.perf.profiling.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.executioncomparison.doc.user/pom.xml
- skeleton/skeleton.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.scripting.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.gpu.doc.user/pom.xml
- doc/org.eclipse.tracecompass.incubator.scripting.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.ftrace.doc.user/plugin.xml
- doc/org.eclipse.tracecompass.incubator.perf.profiling.doc.user/build.xml
- doc/org.eclipse.tracecompass.incubator.lttng2.ust.extras.doc.user/plugin.xml
- skeleton/skeleton.rcp/skeleton.tracecompass.parent/pom.xml
MatthewKhouzam
merged commit acf0796
into
eclipse-tracecompass-incubator:master
3 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What it does
This change fixes errors when doing a Help -> Contents and then initiating a search.
Errors such as:
or
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
Follow-ups
Review checklist
Summary by CodeRabbit