Build documentation index

This speeds up the initial search in the Help. This is mostly useful for bigger
Eclipse installation therefore there is not that much of a difference in the
Trace Compass RCP.

Change-Id: I5edc0ae3350410f7916b8ba625768eaf2a3e6435
Signed-off-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/44409
Reviewed-by: Hudson CI

diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644 (file)
index 0000000..f1ac037
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1 @@
+index/

diff --git a/doc/org.eclipse.tracecompass.doc.dev/.externalToolBuilders/Trace Compass Developer Guide Builder.launch b/doc/org.eclipse.tracecompass.doc.dev/.externalToolBuilders/Trace Compass Developer Guide Builder.launch
index 2b7c51b22164065d750791da68d00e4141cfafa2..ee9b121b8f3d095a540a0aec6fe2c8dc18cd6e98 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.dev/.externalToolBuilders/Trace Compass Developer Guide Builder.launch
+++ b/doc/org.eclipse.tracecompass.doc.dev/.externalToolBuilders/Trace Compass Developer Guide Builder.launch
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType">
 <stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_CLEAN_TARGETS" value="clean,"/>
+<stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_MANUAL_TARGETS" value="build,build.index,"/>
 <booleanAttribute key="org.eclipse.ant.ui.ATTR_TARGETS_UPDATED" value="true"/>
 <booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
 <stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#10;&lt;resources&gt;&#10;&lt;item path=&quot;/org.eclipse.tracecompass.doc.dev&quot; type=&quot;4&quot;/&gt;&#10;&lt;/resources&gt;}"/>

diff --git a/doc/org.eclipse.tracecompass.doc.dev/build.properties b/doc/org.eclipse.tracecompass.doc.dev/build.properties
index 95791899108d44218c26d30bd7d0695eb4357887..88b2770fa5b485a9f30c7b552d2c2578b8b2c41e 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.dev/build.properties
+++ b/doc/org.eclipse.tracecompass.doc.dev/build.properties
@@ -15,7 +15,8 @@ bin.includes = plugin.xml,\
                about.html,\
                plugin.properties,\
                book.css,\
-               doc/
+               doc/,\
+               index/
 jars.extra.classpath = platform:/plugin/org.eclipse.mylyn.wikitext.core,\
                        platform:/plugin/org.eclipse.mylyn.wikitext.mediawiki.core
 src.includes = about.html

diff --git a/doc/org.eclipse.tracecompass.doc.dev/build.xml b/doc/org.eclipse.tracecompass.doc.dev/build.xml
index 78b3bf84f562053b3fcbdfbb25deed816d7e8f34..d07ccc8f643ef89018682672efd1bc7370c28633 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.dev/build.xml
+++ b/doc/org.eclipse.tracecompass.doc.dev/build.xml
@@ -57,4 +57,7 @@
       </delete>
     </target>
 
+    <target name="build.index" description="Builds search index for the plug-in" if="eclipse.running">
+      <help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
+    </target>
 </project>

diff --git a/doc/org.eclipse.tracecompass.doc.dev/plugin.xml b/doc/org.eclipse.tracecompass.doc.dev/plugin.xml
index 34d2d3c17cb76d91a37acf758e748f98aa74631e..f7f9624e3c25115b5cc1f696ce9c77eca06a59e9 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.dev/plugin.xml
+++ b/doc/org.eclipse.tracecompass.doc.dev/plugin.xml
@@ -6,5 +6,8 @@
       <toc
             file="doc/Developer-Guide-toc.xml"
             primary="true" />
+      <index
+            path="index/">
+      </index>
    </extension>
 </plugin>

diff --git a/doc/org.eclipse.tracecompass.doc.dev/pom.xml b/doc/org.eclipse.tracecompass.doc.dev/pom.xml
index c2ea695c21cb6b5ff2242258fefd71d8423702f7..8f40e7eeb5564a84fb1ba2e212c6ac4b2957266e 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.dev/pom.xml
+++ b/doc/org.eclipse.tracecompass.doc.dev/pom.xml
@@ -80,6 +80,34 @@
 
         </dependencies>
       </plugin>
+      <!-- Build help index -->
+      <plugin>
+        <groupId>org.eclipse.tycho.extras</groupId>
+        <artifactId>tycho-eclipserun-plugin</artifactId>
+        <version>${tycho-extras-version}</version>
+        <configuration>
+          <appArgLine>-application org.eclipse.ant.core.antRunner -buildfile build.xml build.index</appArgLine>
+        </configuration>
+      </plugin>
+      <!-- We don't use the ant file to clean because of http://jira.codehaus.org/browse/MANTRUN-78 -->
+      <plugin>
+        <artifactId>maven-clean-plugin</artifactId>
+        <version>2.6.1</version>
+        <executions>
+          <execution>
+            <id>clean-index</id>
+            <phase>clean</phase>
+            <configuration>
+              <filesets>
+                <fileset><directory>index/</directory></fileset>
+              </filesets>
+            </configuration>
+            <goals>
+              <goal>clean</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

diff --git a/doc/org.eclipse.tracecompass.doc.user/.externalToolBuilders/Trace Compass User Guide Builder.launch b/doc/org.eclipse.tracecompass.doc.user/.externalToolBuilders/Trace Compass User Guide Builder.launch
index 1c47d08b2aeb566ccb913ddd6246eed556467539..fb5f5996665073784d86e58f01002db9d4d230d0 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.user/.externalToolBuilders/Trace Compass User Guide Builder.launch
+++ b/doc/org.eclipse.tracecompass.doc.user/.externalToolBuilders/Trace Compass User Guide Builder.launch
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType">
 <stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_CLEAN_TARGETS" value="clean,"/>
+<stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_MANUAL_TARGETS" value="build,build.index,"/>
 <booleanAttribute key="org.eclipse.ant.ui.ATTR_TARGETS_UPDATED" value="true"/>
 <booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
 <stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#10;&lt;resources&gt;&#10;&lt;item path=&quot;/org.eclipse.tracecompass.doc.user&quot; type=&quot;4&quot;/&gt;&#10;&lt;/resources&gt;}"/>

diff --git a/doc/org.eclipse.tracecompass.doc.user/build.properties b/doc/org.eclipse.tracecompass.doc.user/build.properties
index df5ec6a3ff48ae14aa5f22e7cc867fe918edd653..11b4b343f455aef4e72772697a9ea703439a8600 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.user/build.properties
+++ b/doc/org.eclipse.tracecompass.doc.user/build.properties
@@ -16,7 +16,8 @@ bin.includes = plugin.xml,\
                plugin.properties,\
                book.css,\
                doc/,\
-               reference/
+               reference/,\
+               index/
 jars.extra.classpath = platform:/plugin/org.eclipse.mylyn.wikitext.core,\
                        platform:/plugin/org.eclipse.mylyn.wikitext.mediawiki.core
 src.includes = about.html

diff --git a/doc/org.eclipse.tracecompass.doc.user/build.xml b/doc/org.eclipse.tracecompass.doc.user/build.xml
index f9271b3f5ca72674973beae38ad797045de416ae..f590645352401a78a90ffaeeabf3a10f9c66d191 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.user/build.xml
+++ b/doc/org.eclipse.tracecompass.doc.user/build.xml
@@ -57,4 +57,7 @@
       </delete>
     </target>
 
+    <target name="build.index" description="Builds search index for the plug-in" if="eclipse.running">
+      <help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
+    </target>
 </project>

diff --git a/doc/org.eclipse.tracecompass.doc.user/plugin.xml b/doc/org.eclipse.tracecompass.doc.user/plugin.xml
index 8236399816809b844d7c4b7307c470a48b543a70..43800d9f48578dac4e9a10e199c5ac4d28287763 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.user/plugin.xml
+++ b/doc/org.eclipse.tracecompass.doc.user/plugin.xml
@@ -6,5 +6,8 @@
       <toc
             file="doc/User-Guide-toc.xml"
             primary="true" />
+      <index
+            path="index/">
+      </index>
    </extension>
 </plugin>

diff --git a/doc/org.eclipse.tracecompass.doc.user/pom.xml b/doc/org.eclipse.tracecompass.doc.user/pom.xml
index 9f7053694944326c551b5e0718d671515c8518fe..7fb5258beef2f6d48390d956110d724ba45081c2 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.user/pom.xml
+++ b/doc/org.eclipse.tracecompass.doc.user/pom.xml
@@ -80,6 +80,34 @@
 
         </dependencies>
       </plugin>
+      <!-- Build help index -->
+      <plugin>
+        <groupId>org.eclipse.tycho.extras</groupId>
+        <artifactId>tycho-eclipserun-plugin</artifactId>
+        <version>${tycho-extras-version}</version>
+        <configuration>
+          <appArgLine>-application org.eclipse.ant.core.antRunner -buildfile build.xml build.index</appArgLine>
+        </configuration>
+      </plugin>
+      <!-- We don't use the ant file to clean because of http://jira.codehaus.org/browse/MANTRUN-78 -->
+      <plugin>
+        <artifactId>maven-clean-plugin</artifactId>
+        <version>2.6.1</version>
+        <executions>
+          <execution>
+            <id>clean-index</id>
+            <phase>clean</phase>
+            <configuration>
+              <filesets>
+                <fileset><directory>index/</directory></fileset>
+              </filesets>
+            </configuration>
+            <goals>
+              <goal>clean</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

diff --git a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/.externalToolBuilders/Trace Compass GDB Tracepoint Analysis User Guide Builder.launch b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/.externalToolBuilders/Trace Compass GDB Tracepoint Analysis User Guide Builder.launch
index 2e3f95fc3f3c47c6e0e4c3c38055a35bc9ff3db2..09d8c67f1a6f9861cb112b9bc35674457fd4b912 100644 (file)
--- a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/.externalToolBuilders/Trace Compass GDB Tracepoint Analysis User Guide Builder.launch
+++ b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/.externalToolBuilders/Trace Compass GDB Tracepoint Analysis User Guide Builder.launch
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType">
 <stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_CLEAN_TARGETS" value="clean,"/>
+<stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_MANUAL_TARGETS" value="build,build.index,"/>
 <booleanAttribute key="org.eclipse.ant.ui.ATTR_TARGETS_UPDATED" value="true"/>
 <booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
 <stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#10;&lt;resources&gt;&#10;&lt;item path=&quot;/org.eclipse.tracecompass.gdbtrace.doc.user&quot; type=&quot;4&quot;/&gt;&#10;&lt;/resources&gt;}"/>

diff --git a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.properties b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.properties
index 919637863772536cf84df4c1b223e279b5bd7ee3..68490c53882e5fcd863800c773fe43f35232071e 100644 (file)
--- a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.properties
+++ b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.properties
@@ -15,7 +15,8 @@ bin.includes = META-INF/,\
                book.css,\
                doc/,\
                plugin.properties,\
-               plugin.xml
+               plugin.xml,\
+               index/
 jars.extra.classpath = platform:/plugin/org.eclipse.mylyn.wikitext.core,\
                        platform:/plugin/org.eclipse.mylyn.wikitext.mediawiki.core
 src.includes = about.html

diff --git a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml
index a2ad4bee6790ba9923bb65857d5f78ace7f89663..c1df03ee4ee35182dc2ce3aafd351e967992bf61 100644 (file)
--- a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml
+++ b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml
@@ -64,5 +64,7 @@
         <fileset dir="doc" includes="**/*.xml" />
       </delete>
     </target>
-
+    <target name="build.index" description="Builds search index for the plug-in" if="eclipse.running">
+      <help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
+    </target>
 </project>

diff --git a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/plugin.xml b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/plugin.xml
index 151a1fa4dc98ac0763393281be19f5ba60f620f2..86a1cf42ad3d412ac9a0627da0cce6206dfc12d3 100644 (file)
--- a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/plugin.xml
+++ b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/plugin.xml
@@ -14,5 +14,8 @@
       <toc
             file="doc/User-Guide-toc.xml"
             primary="true" />
+      <index
+            path="index/">
+      </index>
    </extension>
 </plugin>

diff --git a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/pom.xml b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/pom.xml
index 927ba0ee71590b7848333d9ab17b6441e81bbebe..c391c5758423577203f0c9f3227cd53426ee1608 100644 (file)
--- a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/pom.xml
+++ b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/pom.xml
@@ -80,6 +80,34 @@
 
         </dependencies>
       </plugin>
+      <!-- Build help index -->
+      <plugin>
+        <groupId>org.eclipse.tycho.extras</groupId>
+        <artifactId>tycho-eclipserun-plugin</artifactId>
+        <version>${tycho-extras-version}</version>
+        <configuration>
+          <appArgLine>-application org.eclipse.ant.core.antRunner -buildfile build.xml build.index</appArgLine>
+        </configuration>
+      </plugin>
+      <!-- We don't use the ant file to clean because of http://jira.codehaus.org/browse/MANTRUN-78 -->
+      <plugin>
+        <artifactId>maven-clean-plugin</artifactId>
+        <version>2.6.1</version>
+        <executions>
+          <execution>
+            <id>clean-index</id>
+            <phase>clean</phase>
+            <configuration>
+              <filesets>
+                <fileset><directory>index/</directory></fileset>
+              </filesets>
+            </configuration>
+            <goals>
+              <goal>clean</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

diff --git a/doc/org.eclipse.tracecompass.rcp.doc.user/.externalToolBuilders/Trace Compass RCP User Guide Builder.launch b/doc/org.eclipse.tracecompass.rcp.doc.user/.externalToolBuilders/Trace Compass RCP User Guide Builder.launch
index 1043fb6eb31340444ed075d33b4c2b31d33f4913..4834dc71c81672af7d0b9eac79c5998ca40fffb2 100644 (file)
--- a/doc/org.eclipse.tracecompass.rcp.doc.user/.externalToolBuilders/Trace Compass RCP User Guide Builder.launch
+++ b/doc/org.eclipse.tracecompass.rcp.doc.user/.externalToolBuilders/Trace Compass RCP User Guide Builder.launch
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType">
 <stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_CLEAN_TARGETS" value="clean,"/>
+<stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_MANUAL_TARGETS" value="build,build.index,"/>
 <booleanAttribute key="org.eclipse.ant.ui.ATTR_TARGETS_UPDATED" value="true"/>
 <booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
 <stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#10;&lt;resources&gt;&#10;&lt;item path=&quot;/org.eclipse.tracecompass.rcp.doc.user&quot; type=&quot;4&quot;/&gt;&#10;&lt;/resources&gt;}"/>

diff --git a/doc/org.eclipse.tracecompass.rcp.doc.user/build.properties b/doc/org.eclipse.tracecompass.rcp.doc.user/build.properties
index 15c5bc749cc1d6d49f3a870ee9c11e4860734f88..37997aec9016696fcc9d746cb4aadf3ac5d6bef1 100644 (file)
--- a/doc/org.eclipse.tracecompass.rcp.doc.user/build.properties
+++ b/doc/org.eclipse.tracecompass.rcp.doc.user/build.properties
@@ -15,7 +15,8 @@ bin.includes = plugin.xml,\
                about.html,\
                plugin.properties,\
                book.css,\
-               doc/
+               doc/,\
+               index/
 jars.extra.classpath = platform:/plugin/org.eclipse.mylyn.wikitext.core,\
                        platform:/plugin/org.eclipse.mylyn.wikitext.mediawiki.core
 src.includes = about.html

diff --git a/doc/org.eclipse.tracecompass.rcp.doc.user/build.xml b/doc/org.eclipse.tracecompass.rcp.doc.user/build.xml
index d723850094f1bb07e7ff3e9753b248e1ca360cd5..6f4e1ca95868979f1e79f1c1544efb3f24855ea4 100644 (file)
--- a/doc/org.eclipse.tracecompass.rcp.doc.user/build.xml
+++ b/doc/org.eclipse.tracecompass.rcp.doc.user/build.xml
@@ -56,5 +56,7 @@
         <fileset dir="doc" includes="**/*.xml" />
       </delete>
     </target>
-
+    <target name="build.index" description="Builds search index for the plug-in" if="eclipse.running">
+      <help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
+    </target>
 </project>

diff --git a/doc/org.eclipse.tracecompass.rcp.doc.user/plugin.xml b/doc/org.eclipse.tracecompass.rcp.doc.user/plugin.xml
index 8236399816809b844d7c4b7307c470a48b543a70..43800d9f48578dac4e9a10e199c5ac4d28287763 100644 (file)
--- a/doc/org.eclipse.tracecompass.rcp.doc.user/plugin.xml
+++ b/doc/org.eclipse.tracecompass.rcp.doc.user/plugin.xml
@@ -6,5 +6,8 @@
       <toc
             file="doc/User-Guide-toc.xml"
             primary="true" />
+      <index
+            path="index/">
+      </index>
    </extension>
 </plugin>

diff --git a/doc/org.eclipse.tracecompass.rcp.doc.user/pom.xml b/doc/org.eclipse.tracecompass.rcp.doc.user/pom.xml
index e47da566005d18447e5672bd5edf732ec220c3e5..34762b1b9df935c970f26a1293cac901b47ec7db 100644 (file)
--- a/doc/org.eclipse.tracecompass.rcp.doc.user/pom.xml
+++ b/doc/org.eclipse.tracecompass.rcp.doc.user/pom.xml
@@ -80,6 +80,34 @@
 
         </dependencies>
       </plugin>
+      <!-- Build help index -->
+      <plugin>
+        <groupId>org.eclipse.tycho.extras</groupId>
+        <artifactId>tycho-eclipserun-plugin</artifactId>
+        <version>${tycho-extras-version}</version>
+        <configuration>
+          <appArgLine>-application org.eclipse.ant.core.antRunner -buildfile build.xml build.index</appArgLine>
+        </configuration>
+      </plugin>
+      <!-- We don't use the ant file to clean because of http://jira.codehaus.org/browse/MANTRUN-78 -->
+      <plugin>
+        <artifactId>maven-clean-plugin</artifactId>
+        <version>2.6.1</version>
+        <executions>
+          <execution>
+            <id>clean-index</id>
+            <phase>clean</phase>
+            <configuration>
+              <filesets>
+                <fileset><directory>index/</directory></fileset>
+              </filesets>
+            </configuration>
+            <goals>
+              <goal>clean</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

diff --git a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/.externalToolBuilders/Trace Compass Pcap User Guide Builder.launch b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/.externalToolBuilders/Trace Compass Pcap User Guide Builder.launch
index 7b0fb928d7eba4c0ec63aa70a772593d7129dc74..1937e6e1736976c868bde9d9bf828913b26a04ed 100644 (file)
--- a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/.externalToolBuilders/Trace Compass Pcap User Guide Builder.launch
+++ b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/.externalToolBuilders/Trace Compass Pcap User Guide Builder.launch
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType">
 <stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_CLEAN_TARGETS" value="clean,"/>
+<stringAttribute key="org.eclipse.ant.ui.ATTR_ANT_MANUAL_TARGETS" value="build,build.index,"/>
 <booleanAttribute key="org.eclipse.ant.ui.ATTR_TARGETS_UPDATED" value="true"/>
 <booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
 <stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#10;&lt;resources&gt;&#10;&lt;item path=&quot;/org.eclipse.tracecompass.tmf.pcap.doc.user&quot; type=&quot;4&quot;/&gt;&#10;&lt;/resources&gt;}"/>

diff --git a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.properties b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.properties
index e090bb73f54725bc11ed0a2c16510ff9ad2fd0b3..2ba79cb767d239105bd0e91f54bbd63c70ed966a 100644 (file)
--- a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.properties
+++ b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.properties
@@ -15,7 +15,8 @@ bin.includes = plugin.xml,\
                about.html,\
                plugin.properties,\
                book.css,\
-               doc/
+               doc/,\
+               index/
 jars.extra.classpath = platform:/plugin/org.eclipse.mylyn.wikitext.core,\
                        platform:/plugin/org.eclipse.mylyn.wikitext.mediawiki.core
 src.includes = about.html

diff --git a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml
index c56835a822cf843661b626fcc045aa21ae4ba31a..6b2d196a41cc86c40d4ced57333dfd4aeed2bc29 100644 (file)
--- a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml
+++ b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml
@@ -56,5 +56,7 @@
         <fileset dir="doc" includes="**/*.xml" />
       </delete>
     </target>
-
+    <target name="build.index" description="Builds search index for the plug-in" if="eclipse.running">
+      <help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
+    </target>
 </project>

diff --git a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/plugin.xml b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/plugin.xml
index 8236399816809b844d7c4b7307c470a48b543a70..43800d9f48578dac4e9a10e199c5ac4d28287763 100644 (file)
--- a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/plugin.xml
+++ b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/plugin.xml
@@ -6,5 +6,8 @@
       <toc
             file="doc/User-Guide-toc.xml"
             primary="true" />
+      <index
+            path="index/">
+      </index>
    </extension>
 </plugin>

diff --git a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/pom.xml b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/pom.xml
index 0a60a8dd4d347e49bac3f74c2736e2e0cfa5e836..cd4f193fb1e2dadcfafa5d1c10c8036d48077456 100644 (file)
--- a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/pom.xml
+++ b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/pom.xml
@@ -80,6 +80,34 @@
 
         </dependencies>
       </plugin>
+      <!-- Build help index -->
+      <plugin>
+        <groupId>org.eclipse.tycho.extras</groupId>
+        <artifactId>tycho-eclipserun-plugin</artifactId>
+        <version>${tycho-extras-version}</version>
+        <configuration>
+          <appArgLine>-application org.eclipse.ant.core.antRunner -buildfile build.xml build.index</appArgLine>
+        </configuration>
+      </plugin>
+      <!-- We don't use the ant file to clean because of http://jira.codehaus.org/browse/MANTRUN-78 -->
+      <plugin>
+        <artifactId>maven-clean-plugin</artifactId>
+        <version>2.6.1</version>
+        <executions>
+          <execution>
+            <id>clean-index</id>
+            <phase>clean</phase>
+            <configuration>
+              <filesets>
+                <fileset><directory>index/</directory></fileset>
+              </filesets>
+            </configuration>
+            <goals>
+              <goal>clean</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

diff --git a/pom.xml b/pom.xml
index 6589bc78514f414125bd0de5df58457fef2d8ff4..c8ff0504a0a60bdc1e36c88254b39020fc4c1c53 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -48,6 +48,7 @@
   <sonar.jacoco.reportPath>${project.basedir}/../target/jacoco.exec</sonar.jacoco.reportPath>
   <sonar.java.source>1.7</sonar.java.source>
   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  <help-docs-eclipserun-repo>http://download.eclipse.org/eclipse/updates/4.4</help-docs-eclipserun-repo>
 </properties>
 
 <pluginRepositories>
@@ -517,6 +518,43 @@
           <artifactId>repository-utils</artifactId>
           <version>0.22.0</version>
         </plugin>
+        <plugin>
+                <groupId>org.eclipse.tycho.extras</groupId>
+                <artifactId>tycho-eclipserun-plugin</artifactId>
+                <version>${tycho-extras-version}</version>
+                <configuration>
+                        <dependencies>
+                                <dependency>
+                                        <artifactId>org.apache.ant</artifactId>
+                                        <type>eclipse-plugin</type>
+                                </dependency>
+                                <dependency>
+                                        <artifactId>org.eclipse.help.base</artifactId>
+                                        <type>eclipse-plugin</type>
+                                </dependency>
+                                <dependency>
+                                        <artifactId>org.eclipse.ant.core</artifactId>
+                                        <type>eclipse-plugin</type>
+                                </dependency>
+                        </dependencies>
+                        <!-- This needs to be explicitely set now, see https://bugs.eclipse.org/bugs/show_bug.cgi?id=395281 -->
+                        <repositories>
+                                <repository>
+                                        <id>platform</id>
+                                        <layout>p2</layout>
+                                        <url>${help-docs-eclipserun-repo}</url>
+                                </repository>
+                        </repositories>
+                </configuration>
+                <executions>
+                        <execution>
+                                <goals>
+                                        <goal>eclipse-run</goal>
+                                </goals>
+                                <phase>compile</phase>
+                        </execution>
+                </executions>
+        </plugin>
       </plugins>
     </pluginManagement>
   </build>