doc: Clean up the build.xml Ant files

* Remove the "download" targets. We do not store the doc on a
  wiki anymore.
* Remove the pre-Luna Mylyn task location
* Keep only one instance of some commonly-used files, directly
  under the doc/ directory.

Change-Id: Ibfad6aa2ba332ebb3aec2de255a93fea38d5b1f7
Signed-off-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Reviewed-on: https://git.eclipse.org/r/41031
Reviewed-by: Hudson CI
Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com>

diff --git a/doc/.empty.dtd b/doc/.empty.dtd
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/doc/org.eclipse.tracecompass.doc.dev/.empty.dtd b/doc/org.eclipse.tracecompass.doc.dev/.empty.dtd
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/doc/org.eclipse.tracecompass.doc.dev/build.xml b/doc/org.eclipse.tracecompass.doc.dev/build.xml
index e5b928dd939351b3267bf7bdf9c31286e5ff3cc6..78b3bf84f562053b3fcbdfbb25deed816d7e8f34 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.dev/build.xml
+++ b/doc/org.eclipse.tracecompass.doc.dev/build.xml
@@ -4,7 +4,7 @@
         Generate Eclipse help content for the Trace Compass Developer Guide
     </description>
 
-   <property name="ug.title" value="Trace Compass Developer Guide" />
+    <property name="document.title" value="Trace Compass Developer Guide" />
 
     <path id="wikitext.tasks.classpath">
         <!-- Search in the local Eclipse plugins directory for the Wikitext plugin -->
@@ -17,19 +17,16 @@
         <pathelement path="${compile_classpath}" />
     </path>
 
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
-    <!-- Different location in more recent versions of Mylyn (Luna ?) -->
     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
 
-    <target name="build" description="Generate Eclipse help content for the Linux Tools TMF Developer Guide">
+    <target name="build" description="Generate Eclipse help content for the Trace Compass Developer Guide">
         <wikitext-to-eclipse-help markupLanguage="MediaWiki"
             validate="true"
             failonvalidationerror="true"
             overwrite="true"
             multipleOutputFiles="true"
             navigationimages="true"
-            title="${ug.title}"
+            title="${document.title}"
             formatoutput="true"
             helpPrefix="doc">
             <fileset dir="doc">
@@ -49,7 +46,7 @@
             <fileset dir="doc">
                 <include name="**/*.html" />
             </fileset>
-            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location=".empty.dtd" />
+            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="../.empty.dtd" />
         </xmlvalidate>
     </target>
 

diff --git a/doc/org.eclipse.tracecompass.doc.user/.empty.dtd b/doc/org.eclipse.tracecompass.doc.user/.empty.dtd
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/doc/org.eclipse.tracecompass.doc.user/build.xml b/doc/org.eclipse.tracecompass.doc.user/build.xml
index 209c949d7cdb674fa1ab3b74dd947195a93d5c38..f9271b3f5ca72674973beae38ad797045de416ae 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.user/build.xml
+++ b/doc/org.eclipse.tracecompass.doc.user/build.xml
@@ -1,13 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project name="org.eclipse.tracecompass.doc.user" default="build">
     <description>
-            Generate Eclipse help content for the Trace Compass user guide
+            Generate Eclipse help content for the Trace Compass User Guide
     </description>
 
-    <!-- Set correct values -->
-    <property name="help.doc.url.base" value="http://wiki.eclipse.org" />
-    <property name="ug.path"  value="Linux_Tools_Project/LTTng2/User_Guide" />
-    <property name="ug.title" value="LTTng Plug-in User Guide" />
+    <property name="document.title" value="Trace Compass User Guide" />
 
     <path id="wikitext.tasks.classpath">
         <!-- Search in the local Eclipse plugins directory for the Wikitext plugin -->
@@ -20,9 +17,6 @@
         <pathelement path="${compile_classpath}" />
     </path>
 
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
-    <!-- Different location in more recent versions of Mylyn (Luna ?) -->
     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
 
     <target name="build" description="Generate Eclipse help content for the Trace Compass User Guide">
@@ -32,7 +26,7 @@
                 overwrite="true"
                 multipleOutputFiles="true"
                 navigationimages="true"
-                title="${ug.title}"
+                title="${document.title}"
                 formatoutput="true"
                 helpPrefix="doc">
                 <fileset dir="./doc">
@@ -52,38 +46,14 @@
             <fileset dir="doc">
                 <include name="**/*.html" />
             </fileset>
-            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location=".empty.dtd" />
+            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="../.empty.dtd" />
         </xmlvalidate>
     </target>
 
-
-    <!-- If you need a proxy for the "download" target, set it here -->
-    <!--
-    <setproxy proxyhost="host" proxyport="port"/>
-    -->
-
-    <target name="download" description="Download the current contents of the Trace Compass User Guide from the Eclipse wiki">
-        <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="${ug.title}" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
-            <path name="${ug.path}" title="${ug.title}" generateToc="false" />
-            <stylesheet url="book.css" />
-            <pageAppendum>
-= Updating This Document =
-
-This document is maintained in a collaborative wiki.  If you wish to update or modify this document please visit
-http://wiki.eclipse.org/Linux_Tools_Project/LTTng2/User_Guide.
-            </pageAppendum>
-        </mediawiki-to-eclipse-help>
-    </target>
-
     <target name ="clean" description="Delete all generated files">
       <delete failonerror="false" includeemptydirs="true">
-        <!-- Files under doc/ (generated locally) -->
         <fileset dir="doc" includes="**/*.html" />
         <fileset dir="doc" includes="**/*.xml" />
-
-        <!-- Files downloaded from the Eclipse wiki -->
-        <fileset dir="Linux_Tools_Project" />
-        <fileset file="toc.xml" />
       </delete>
     </target>
 

diff --git a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/.empty.dtd b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/.empty.dtd
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml
index 16ede4faefb1e2ab8d12bc0dc9825bd0b427f5b6..a2ad4bee6790ba9923bb65857d5f78ace7f89663 100644 (file)
--- a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml
+++ b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml
@@ -9,13 +9,10 @@
 -->
 <project name="org.eclipse.tracecompass.gdbtrace.doc.user" default="build">
     <description>
-            Generate Eclipse help content for the Trace Compass GDB Tracepoint Analysis user guide
+            Generate Eclipse help content for the Trace Compass GDB Tracepoint Analysis User Guide
     </description>
 
-    <!-- Set correct values -->
-    <property name="help.doc.url.base" value="http://wiki.eclipse.org" />
-    <property name="ug.path"  value="Linux_Tools_Project/GDB_Tracepoint_Analysis/User_Guide" />
-    <property name="ug.title" value="GDB Tracepoint Analysis User Guide" />
+    <property name="document.title" value="GDB Tracepoint Analysis User Guide" />
 
     <path id="wikitext.tasks.classpath">
         <!-- Search in the local Eclipse plugins directory for the Wikitext plugin -->
@@ -28,19 +25,16 @@
         <pathelement path="${compile_classpath}" />
     </path>
 
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
-    <!-- Different location in more recent versions of Mylyn (Luna ?) -->
     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
 
-    <target name="build" description="Generate Eclipse help content for the Linux Tools GDB Tracepoint Analysis User Guide">
+    <target name="build" description="Generate Eclipse help content for the Trace Compass GDB Tracepoint Analysis User Guide">
         <wikitext-to-eclipse-help markupLanguage="MediaWiki"
                 validate="true"
                 failonvalidationerror="true"
                 overwrite="true"
                 multipleOutputFiles="true"
                 navigationimages="true"
-                title="${ug.title}"
+                title="${document.title}"
                 formatoutput="true"
                 helpPrefix="doc">
                 <fileset dir="./doc">
@@ -60,37 +54,14 @@
             <fileset dir="doc">
                 <include name="**/*.html" />
             </fileset>
-            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location=".empty.dtd" />
+            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="../.empty.dtd" />
         </xmlvalidate>
     </target>
 
-    <!-- If you need a proxy for the "download" target, set it here -->
-    <!--
-    <setproxy proxyhost="host" proxyport="port"/>
-    -->
-
-    <target name="download" description="Download the current contents of the GDB Tracepoint Analysis User Guide from the Eclipse wiki">
-        <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="${ug.title}" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
-            <path name="${ug.path}" title="${ug.title}" generateToc="false" />
-            <stylesheet url="book.css" />
-            <pageAppendum>
-= Updating This Document =
-
-This document is maintained in a collaborative wiki.  If you wish to update or modify this document please visit
-http://wiki.eclipse.org/Linux_Tools_Project/GDB_Tracepoint_Analysis/User_Guide.
-            </pageAppendum>
-        </mediawiki-to-eclipse-help>
-    </target>
-
     <target name ="clean" description="Delete all generated files">
       <delete failonerror="false" includeemptydirs="true">
-        <!-- Files under doc/ (generated locally) -->
         <fileset dir="doc" includes="**/*.html" />
         <fileset dir="doc" includes="**/*.xml" />
-
-        <!-- Files downloaded from the Eclipse wiki -->
-        <fileset dir="Linux_Tools_Project" />
-        <fileset file="toc.xml" />
       </delete>
     </target>
 

diff --git a/doc/org.eclipse.tracecompass.rcp.doc.user/.empty.dtd b/doc/org.eclipse.tracecompass.rcp.doc.user/.empty.dtd
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/doc/org.eclipse.tracecompass.rcp.doc.user/build.xml b/doc/org.eclipse.tracecompass.rcp.doc.user/build.xml
index 15c3f571903af0a2fd54bb9b6b0a9a7c08910174..d723850094f1bb07e7ff3e9753b248e1ca360cd5 100644 (file)
--- a/doc/org.eclipse.tracecompass.rcp.doc.user/build.xml
+++ b/doc/org.eclipse.tracecompass.rcp.doc.user/build.xml
@@ -4,10 +4,7 @@
             Generate Eclipse help content for the Trace Compass RCP user guide
     </description>
 
-    <!-- Set correct values -->
-    <property name="help.doc.url.base" value="http://wiki.eclipse.org" />
-    <property name="ug.path"  value="Linux_Tools_Project/Trace_Viewer/User_Guide" />
-    <property name="ug.title" value="Trace Compass RCP User Guide" />
+    <property name="document.title" value="Trace Compass RCP User Guide" />
 
     <path id="wikitext.tasks.classpath">
         <!-- Search in the local Eclipse plugins directory for the Wikitext plugin -->
@@ -20,9 +17,6 @@
         <pathelement path="${compile_classpath}" />
     </path>
 
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
-    <!-- Different location in more recent versions of Mylyn (Luna ?) -->
     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
 
     <target name="build" description="Generate Eclipse help content for the Trace Compass RCP User Guide">
@@ -32,7 +26,7 @@
                 overwrite="true"
                 multipleOutputFiles="true"
                 navigationimages="true"
-                title="${ug.title}"
+                title="${document.title}"
                 formatoutput="true"
                 helpPrefix="doc">
                 <fileset dir="./doc">
@@ -52,38 +46,14 @@
             <fileset dir="doc">
                 <include name="**/*.html" />
             </fileset>
-            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location=".empty.dtd" />
+            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="../.empty.dtd" />
         </xmlvalidate>
     </target>
 
-
-    <!-- If you need a proxy for the "download" target, set it here -->
-    <!--
-    <setproxy proxyhost="host" proxyport="port"/>
-    -->
-
-    <target name="download" description="Download the current contents of the LTTng User Guide from the Eclipse wiki">
-        <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="${ug.title}" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
-            <path name="${ug.path}" title="${ug.title}" generateToc="false" />
-            <stylesheet url="book.css" />
-            <pageAppendum>
-= Updating This Document =
-
-This document is maintained in a collaborative wiki.  If you wish to update or modify this document please visit
-http://wiki.eclipse.org/Linux_Tools_Project/LTTng2/User_Guide.
-            </pageAppendum>
-        </mediawiki-to-eclipse-help>
-    </target>
-
     <target name ="clean" description="Delete all generated files">
       <delete failonerror="false" includeemptydirs="true">
-        <!-- Files under doc/ (generated locally) -->
         <fileset dir="doc" includes="**/*.html" />
         <fileset dir="doc" includes="**/*.xml" />
-
-        <!-- Files downloaded from the Eclipse wiki -->
-        <fileset dir="Linux_Tools_Project" />
-        <fileset file="toc.xml" />
       </delete>
     </target>
 

diff --git a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/.empty.dtd b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/.empty.dtd
deleted file mode 100644 (file)
index e69de29..0000000

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 906fdf69d94d3370b896dfe61de14a4692098923..c56835a822cf843661b626fcc045aa21ae4ba31a 100644 (file)
--- a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml
+++ b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/build.xml
@@ -4,7 +4,7 @@
         Generate Eclipse help content for the Trace Compass Pcap User Guide
     </description>
 
-   <property name="ug.title" value="Pcap Network Tracing User Guide" />
+   <property name="document.title" value="Pcap Network Tracing User Guide" />
 
     <path id="wikitext.tasks.classpath">
         <!-- Search in the local Eclipse plugins directory for the Wikitext plugin -->
@@ -17,9 +17,6 @@
         <pathelement path="${compile_classpath}" />
     </path>
 
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
-    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
-    <!-- Different location in more recent versions of Mylyn (Luna ?) -->
     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
 
     <target name="build" description="Generate Eclipse help content for the Trace Compass Pcap User Guide">
@@ -29,7 +26,7 @@
             overwrite="true"
             multipleOutputFiles="true"
             navigationimages="true"
-            title="${ug.title}"
+            title="${document.title}"
             formatoutput="true"
             helpPrefix="doc">
             <fileset dir="doc">
@@ -49,7 +46,7 @@
             <fileset dir="doc">
                 <include name="**/*.html" />
             </fileset>
-            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location=".empty.dtd" />
+            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="../.empty.dtd" />
         </xmlvalidate>
     </target>