mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-04-29 19:45:01 +02:00
Bug 157260 - Add custom callbacks to call the buildDoc script to generate the API docs. Also get rid of the user doc's build.xml file since we use the generated one anyway.
This commit is contained in:
Doug Schaefer
parent
7c00a4e656
commit
b545010fbd
3 changed files with 161 additions and 75 deletions
|
|
@ -20,3 +20,5 @@ bin.includes = META-INF/,\
|
|||
plugin.xml,\
|
||||
plugin.properties,\
|
||||
notices.html
|
||||
|
||||
customBuildCallbacks = customBuildCallbacks.xml
|
||||
|
|
|
|||
159
doc/org.eclipse.cdt.doc.isv/customBuildCallbacks.xml
Normal file
159
doc/org.eclipse.cdt.doc.isv/customBuildCallbacks.xml
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
<!-- ===================================================================== -->
|
||||
<!-- 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">
|
||||
<ant antfile="buildDoc.xml"/>
|
||||
</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">
|
||||
</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>
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project name="org.eclipse.jdt.doc.user" default="build.jars" basedir=".">
|
||||
|
||||
<target name="init">
|
||||
<property name="plugin" value="org.eclipse.cdt.doc.user"/>
|
||||
<property name="version.suffix" value="_3.0.0"/>
|
||||
<property name="full.name" value="${plugin}${version.suffix}"/>
|
||||
<property name="temp.folder" value="${basedir}/temp.folder"/>
|
||||
<property name="plugin.destination" value="${basedir}"/>
|
||||
<property name="build.result.folder" value="${basedir}"/>
|
||||
</target>
|
||||
|
||||
<target name="build.update.jar" depends="init">
|
||||
<delete dir="${temp.folder}"/>
|
||||
<mkdir dir="${temp.folder}"/>
|
||||
<antcall target="build.jars"/>
|
||||
<antcall target="gather.bin.parts">
|
||||
<param name="destination.temp.folder" value="${temp.folder}/"/>
|
||||
</antcall>
|
||||
<zip zipfile="${plugin.destination}/${full.name}.jar" basedir="${temp.folder}/${full.name}" filesonly="false"/>
|
||||
<delete dir="${temp.folder}"/>
|
||||
</target>
|
||||
|
||||
<target name="gather.bin.parts" depends="init" if="destination.temp.folder">
|
||||
<mkdir dir="${destination.temp.folder}/${full.name}"/>
|
||||
<zip zipfile="${destination.temp.folder}/${full.name}/doc.zip"
|
||||
basedir="${basedir}"
|
||||
includes="*.css, hglegal.htm, ngibmcpy.gif, concepts/**, getting_started/**, images/**, reference/**, tasks/**, tips/**, whatsNew/**, cheatsheets/**"
|
||||
/>
|
||||
<copy todir="${destination.temp.folder}/${full.name}">
|
||||
<fileset dir="${basedir}" includes="*.properties,*.xml,*.zip,*.html,*.htm,*.gif,*.css" excludes="build.properties,build.xml"/>
|
||||
</copy>
|
||||
</target>
|
||||
|
||||
<target name="build.jars" depends="init">
|
||||
</target>
|
||||
|
||||
<target name="gather.sources" depends="init" if="destination.temp.folder">
|
||||
</target>
|
||||
|
||||
<target name="build.sources" depends="init">
|
||||
</target>
|
||||
|
||||
<target name="gather.logs" depends="init" if="destination.temp.folder">
|
||||
</target>
|
||||
|
||||
<target name="clean" depends="init">
|
||||
<delete file="${plugin.destination}/${full.name}.jar"/>
|
||||
<delete file="${plugin.destination}/${full.name}.zip"/>
|
||||
<delete dir="${temp.folder}"/>
|
||||
</target>
|
||||
|
||||
<target name="refresh" depends="init" if="eclipse.running">
|
||||
<eclipse.refreshLocal resource="${plugin}" depth="infinite"/>
|
||||
</target>
|
||||
|
||||
<target name="zip.plugin" depends="init">
|
||||
<delete dir="${temp.folder}"/>
|
||||
<mkdir dir="${temp.folder}"/>
|
||||
<antcall target="build.jars"/>
|
||||
<antcall target="build.sources"/>
|
||||
<antcall target="gather.bin.parts">
|
||||
<param name="destination.temp.folder" value="${temp.folder}/"/>
|
||||
</antcall>
|
||||
<antcall target="gather.sources">
|
||||
<param name="destination.temp.folder" value="${temp.folder}/"/>
|
||||
</antcall>
|
||||
<delete>
|
||||
<fileset dir="${temp.folder}" includes="**/*.bin.log"/>
|
||||
</delete>
|
||||
<zip zipfile="${plugin.destination}/${full.name}.zip" basedir="${temp.folder}" filesonly="true"/>
|
||||
<delete dir="${temp.folder}"/>
|
||||
</target>
|
||||
|
||||
</project>
|
||||
Loading…
Add table
Reference in a new issue