Skip to main content
summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDoug Schaefer2011-09-12 14:44:43 -0400
committerMarc-Andre Laperle2012-01-15 03:09:18 -0500
commitd81d0b24e75afe2e5463a81d8b1049059ceadca4 (patch)
tree11493050a725c0e5d8eb57afaf002125a9cc0d24 /doc
parentd98768295b4ad9f212dfd55c84b53ae9a2cab4ca (diff)
downloadorg.eclipse.cdt-d81d0b24e75afe2e5463a81d8b1049059ceadca4.tar.gz
org.eclipse.cdt-d81d0b24e75afe2e5463a81d8b1049059ceadca4.tar.xz
org.eclipse.cdt-d81d0b24e75afe2e5463a81d8b1049059ceadca4.zip
Bug 350828 - Prebuild indexes for docs.
Diffstat (limited to 'doc')
-rw-r--r--doc/org.eclipse.cdt.doc.isv/build.properties3
-rw-r--r--doc/org.eclipse.cdt.doc.isv/buildDoc.xml7
-rw-r--r--doc/org.eclipse.cdt.doc.isv/plugin.xml1
-rw-r--r--doc/org.eclipse.cdt.doc.user/build.properties11
-rw-r--r--doc/org.eclipse.cdt.doc.user/customBuildCallbacks.xml163
-rw-r--r--doc/org.eclipse.cdt.doc.user/plugin.xml2
6 files changed, 183 insertions, 4 deletions
diff --git a/doc/org.eclipse.cdt.doc.isv/build.properties b/doc/org.eclipse.cdt.doc.isv/build.properties
index 7f30dbe731..57d97a2b70 100644
--- a/doc/org.eclipse.cdt.doc.isv/build.properties
+++ b/doc/org.eclipse.cdt.doc.isv/build.properties
@@ -1,5 +1,5 @@
###############################################################################
-# Copyright (c) 2005, 2007 IBM Corporation and others.
+# Copyright (c) 2005, 2011 IBM Corporation and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
@@ -19,6 +19,7 @@ bin.includes = META-INF/,\
topics_Reference.xml,\
plugin.xml,\
plugin.properties,\
+ index/,\
notices.html
customBuildCallbacks = customBuildCallbacks.xml
diff --git a/doc/org.eclipse.cdt.doc.isv/buildDoc.xml b/doc/org.eclipse.cdt.doc.isv/buildDoc.xml
index 7a76a66438..6056e45b67 100644
--- a/doc/org.eclipse.cdt.doc.isv/buildDoc.xml
+++ b/doc/org.eclipse.cdt.doc.isv/buildDoc.xml
@@ -5,8 +5,13 @@
<antcall target="convertSchemaToHtml" />
<!--antcall target="examplesDocCopy" /-->
<antcall target="generateJavadoc" />
+ <antcall target="build.index" />
</target>
-
+
+ <target name="build.index" description="Builds search index for the plug-in: org.eclipse.cdt.doc.isv" if="eclipse.running">
+ <help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
+ </target>
+
<target name="convertSchemaToHtml" if="eclipse.running">
<property name="dest" value="reference/extension-points" />
<record name="${basedir}/cdtconvert.txt" action="start"/>
diff --git a/doc/org.eclipse.cdt.doc.isv/plugin.xml b/doc/org.eclipse.cdt.doc.isv/plugin.xml
index 8fd8370468..870c647db7 100644
--- a/doc/org.eclipse.cdt.doc.isv/plugin.xml
+++ b/doc/org.eclipse.cdt.doc.isv/plugin.xml
@@ -12,6 +12,7 @@
<toc
primary="false"
file="topics_Reference.xml"/>
+ <index path="index/"/>
</extension>
</plugin>
diff --git a/doc/org.eclipse.cdt.doc.user/build.properties b/doc/org.eclipse.cdt.doc.user/build.properties
index 9e420ae62e..4f622f31dd 100644
--- a/doc/org.eclipse.cdt.doc.user/build.properties
+++ b/doc/org.eclipse.cdt.doc.user/build.properties
@@ -1,5 +1,5 @@
###############################################################################
-# Copyright (c) 2000, 2007 IBM Corporation and others.
+# Copyright (c) 2000, 2011 IBM Corporation and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
@@ -8,6 +8,9 @@
# Contributors:
# IBM Corporation - initial API and implementation
###############################################################################
+
+customBuildCallbacks=customBuildCallbacks.xml
+
bin.includes = about.html,\
concepts/,\
contexts_CDT.xml,\
@@ -31,4 +34,8 @@ bin.includes = about.html,\
cheatsheets/,\
intro/,\
notices.html,\
- book.css
+ book.css,\
+ index*/
+
+bin.excludes = build.properties,\
+ customBuildCallbacks.xml
diff --git a/doc/org.eclipse.cdt.doc.user/customBuildCallbacks.xml b/doc/org.eclipse.cdt.doc.user/customBuildCallbacks.xml
new file mode 100644
index 0000000000..e0a92a65f0
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/customBuildCallbacks.xml
@@ -0,0 +1,163 @@
+<!-- ===================================================================== -->
+<!-- Custom targets called from a project's generated build.xml -->
+<!-- Set customBuildCallbacks=<path/to/this/file> in your build.properties.-->
+<!-- ===================================================================== -->
+<project name="Build specific targets and properties" default="noDefault">
+
+ <!-- ===================================================================== -->
+ <!-- Default target -->
+ <!-- ===================================================================== -->
+ <target name="noDefault">
+ <echo message="This file must be called with explicit targets" />
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target build.jars -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder to contain the build results -->
+ <!-- ===================================================================== -->
+ <target name="pre.build.jars">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target build.jars -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder to contain the build results -->
+ <!-- ===================================================================== -->
+ <target name="post.build.jars">
+ <antcall target="build.index"/>
+ </target>
+
+ <target name="build.index" description="Builds search index for the plug-in: org.eclipse.rse.doc.user." if="eclipse.running">
+ <help.buildHelpIndex manifest="plugin.xml" destination="."/>
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target build.sources -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder to contain the build results -->
+ <!-- ===================================================================== -->
+ <target name="pre.build.sources">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target build.sources -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder to contain the build results -->
+ <!-- ===================================================================== -->
+ <target name="post.build.sources">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the compilation target <name> -->
+ <!-- Substitute "name" with the name of the compilation target, eg @dot -->
+ <!-- Available parameters : -->
+ <!-- source.foldern : n = 1 ... N, the source folders -->
+ <!-- target.folder : where the results of the compilation go -->
+ <!-- <name>.classpath : name = name of the compilation target. A -->
+ <!-- reference to the classpath structure. -->
+ <!-- ===================================================================== -->
+ <target name="pre.name">
+ </target>
+
+ <target name="pre.@dot">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do during the compilation target <name>, after the compile -->
+ <!-- but before jaring. Substitute "name" with the name of the compilation-->
+ <!-- target, eg @dot -->
+ <!-- Available parameters : -->
+ <!-- source.foldern : n = 1 ... N, the source folders -->
+ <!-- target.folder : where the results of the compilation go -->
+ <!-- <name>.classpath : name = name of the compilation target. A -->
+ <!-- reference to the classpath structure. -->
+ <!-- ===================================================================== -->
+ <target name="post.compile.name">
+ </target>
+
+ <target name="post.compile.@dot">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the compilation target <name> -->
+ <!-- Substitute "name" with the name of the compilation target, eg @dot -->
+ <!-- Available parameters : -->
+ <!-- jar.Location - the location of the compilation results -->
+ <!-- <name>.classpath : name = name of the compilation target. A -->
+ <!-- reference to the classpath structure. -->
+ <!-- ===================================================================== -->
+ <target name="post.name">
+ </target>
+
+ <target name="post.@dot">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target gather.bin.parts -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder containing the build results -->
+ <!-- target.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="pre.gather.bin.parts">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target gather.bin.parts -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder containing the build results -->
+ <!-- target.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="post.gather.bin.parts">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target gather.sources -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="pre.gather.sources">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target gather.sources -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="post.gather.sources">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target gather.logs -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="pre.gather.logs">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target gather.logs -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="post.gather.logs">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target clean -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="pre.clean">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target clean -->
+ <!-- Available parameters : -->
+ <!-- plugin.destination - final destination of the build -->
+ <!-- build.result.folder - results of the compilation -->
+ <!-- temp.folder - temporary folder -->
+ <!-- ===================================================================== -->
+ <target name="post.clean">
+ </target>
+</project>
diff --git a/doc/org.eclipse.cdt.doc.user/plugin.xml b/doc/org.eclipse.cdt.doc.user/plugin.xml
index 52d47285a6..3b6edfe6b5 100644
--- a/doc/org.eclipse.cdt.doc.user/plugin.xml
+++ b/doc/org.eclipse.cdt.doc.user/plugin.xml
@@ -14,7 +14,9 @@
file="toc.xml"
primary="true">
</toc>
+ <index path="index"/>
</extension>
+
<!-- ============================================================================= -->
<!-- Define TOCs -->
<!-- ============================================================================= -->

Back to the top