From 12e9e01df77961f002d6b617280e0e7d272db7cb Mon Sep 17 00:00:00 2001 From: Alexander Kurtakov Date: Wed, 10 May 2017 13:40:31 +0300 Subject: releng: Automate regeneration of help content from wiki. Calling mvn with -PregenHelp will regenerate all the help docs content. Change-Id: Ib3361133c33ef306d5f82e9bf88a62e772c8cac0 Signed-off-by: Alexander Kurtakov Reviewed-on: https://git.eclipse.org/r/96717 Tested-by: Hudson CI --- .../build-helper.xml | 9 --- .../org.eclipse.linuxtools.changelog.doc/pom.xml | 21 ++++++- .../build-helper.xml | 9 --- .../org.eclipse.linuxtools.docker.docs/pom.xml | 21 ++++++- .../build-helper.xml | 9 --- gcov/org.eclipse.linuxtools.gcov.docs/pom.xml | 20 +++++- .../build-doc.xml | 73 ---------------------- .../build-helper.xml | 63 +++++++++++++++++++ .../build.properties | 2 +- gprof/org.eclipse.linuxtools.gprof.docs/pom.xml | 21 ++++++- .../build-helper.xml | 10 --- .../pom.xml | 19 ++++++ .../build-helper.xml | 10 --- .../org.eclipse.linuxtools.oprofile.doc/pom.xml | 21 ++++++- .../build-helper.xml | 10 --- perf/org.eclipse.linuxtools.perf.doc/pom.xml | 19 ++++++ pom.xml | 36 +++++++++++ .../build-helper.xml | 10 --- .../org.eclipse.linuxtools.profiling.docs/pom.xml | 18 ++++++ .../pom.xml | 19 ------ .../build-doc.xml | 72 --------------------- .../build-helper.xml | 62 ++++++++++++++++++ .../org.eclipse.linuxtools.callgraph.docs/pom.xml | 21 ++++++- .../build-helper.xml | 10 --- .../pom.xml | 21 ++++++- .../build-helper.xml | 9 --- .../org.eclipse.linuxtools.vagrant.docs/pom.xml | 21 ++++++- .../build-helper.xml | 10 --- .../org.eclipse.linuxtools.valgrind.doc/pom.xml | 21 ++++++- 29 files changed, 397 insertions(+), 270 deletions(-) delete mode 100644 gprof/org.eclipse.linuxtools.gprof.docs/build-doc.xml create mode 100644 gprof/org.eclipse.linuxtools.gprof.docs/build-helper.xml delete mode 100644 systemtap/org.eclipse.linuxtools.callgraph.docs/build-doc.xml create mode 100644 systemtap/org.eclipse.linuxtools.callgraph.docs/build-helper.xml diff --git a/changelog/org.eclipse.linuxtools.changelog.doc/build-helper.xml b/changelog/org.eclipse.linuxtools.changelog.doc/build-helper.xml index 0062c117ce..524630693b 100644 --- a/changelog/org.eclipse.linuxtools.changelog.doc/build-helper.xml +++ b/changelog/org.eclipse.linuxtools.changelog.doc/build-helper.xml @@ -7,15 +7,6 @@ - - - - - - - - - diff --git a/changelog/org.eclipse.linuxtools.changelog.doc/pom.xml b/changelog/org.eclipse.linuxtools.changelog.doc/pom.xml index 6f2753258d..bd13421ce5 100644 --- a/changelog/org.eclipse.linuxtools.changelog.doc/pom.xml +++ b/changelog/org.eclipse.linuxtools.changelog.doc/pom.xml @@ -1,6 +1,6 @@ - - - - - - - diff --git a/containers/org.eclipse.linuxtools.docker.docs/pom.xml b/containers/org.eclipse.linuxtools.docker.docs/pom.xml index f763804006..a93cf5d38d 100644 --- a/containers/org.eclipse.linuxtools.docker.docs/pom.xml +++ b/containers/org.eclipse.linuxtools.docker.docs/pom.xml @@ -1,6 +1,6 @@ - - - - - - - diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/pom.xml b/gcov/org.eclipse.linuxtools.gcov.docs/pom.xml index f3279c2d0d..7a30cb5792 100644 --- a/gcov/org.eclipse.linuxtools.gcov.docs/pom.xml +++ b/gcov/org.eclipse.linuxtools.gcov.docs/pom.xml @@ -1,6 +1,6 @@ - - - - Generate Eclipse help content from the Eclipsepedia wiki - - - - - - - - - - - - - - - - - - - - - - - = 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/GProf/User_Guide . - - - - - - - -Validating help content XML and HTML files: The Eclipse help system expects well-formed XML - -If validation fails it is because either: - -* the userguide source code is poorly formed, or -* the WikiText MediaWiki parser has a bug - -Problems with userguide source are usually caused by improper use of HTML markup in the MediaWiki source, -or inadvertently starting a line with a space character (in MediaWiki this starts a preformatted block) - - - - - - - - - - - - - diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/build-helper.xml b/gprof/org.eclipse.linuxtools.gprof.docs/build-helper.xml new file mode 100644 index 0000000000..6a6dd6497f --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/build-helper.xml @@ -0,0 +1,63 @@ + + + + + + Generate Eclipse help content from the Eclipsepedia wiki + + + + + + + + + + + + + = 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/GProf/User_Guide . + + + + + + + +Validating help content XML and HTML files: The Eclipse help system expects well-formed XML + +If validation fails it is because either: + +* the userguide source code is poorly formed, or +* the WikiText MediaWiki parser has a bug + +Problems with userguide source are usually caused by improper use of HTML markup in the MediaWiki source, +or inadvertently starting a line with a space character (in MediaWiki this starts a preformatted block) + + + + + + + + + + + + + diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/build.properties b/gprof/org.eclipse.linuxtools.gprof.docs/build.properties index 25571bcc80..f2ca5d8e9c 100644 --- a/gprof/org.eclipse.linuxtools.gprof.docs/build.properties +++ b/gprof/org.eclipse.linuxtools.gprof.docs/build.properties @@ -6,7 +6,7 @@ bin.includes = META-INF/,\ Linux_Tools_Project/,\ images/,\ plugin.xml,\ - build-doc.xml,\ + build-helper.xml,\ toc.xml,\ book.css src.includes = about.html diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/pom.xml b/gprof/org.eclipse.linuxtools.gprof.docs/pom.xml index 0852629974..26bb40ddc8 100644 --- a/gprof/org.eclipse.linuxtools.gprof.docs/pom.xml +++ b/gprof/org.eclipse.linuxtools.gprof.docs/pom.xml @@ -1,6 +1,6 @@ - - - - - - - - diff --git a/libhover/org.eclipse.linuxtools.cdt.libhover.library.docs/pom.xml b/libhover/org.eclipse.linuxtools.cdt.libhover.library.docs/pom.xml index db41832ee2..aac42db924 100644 --- a/libhover/org.eclipse.linuxtools.cdt.libhover.library.docs/pom.xml +++ b/libhover/org.eclipse.linuxtools.cdt.libhover.library.docs/pom.xml @@ -22,4 +22,23 @@ eclipse-plugin Linux Tools Libhover Library Documentation Plug-in + + + + regenHelp + + + + maven-antrun-plugin + + + helpdocs + generate-resources + + + + + + + diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/build-helper.xml b/oprofile/org.eclipse.linuxtools.oprofile.doc/build-helper.xml index 7604d9c157..e2131a089d 100644 --- a/oprofile/org.eclipse.linuxtools.oprofile.doc/build-helper.xml +++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/build-helper.xml @@ -6,16 +6,6 @@ - - - - - - - - - - diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/pom.xml b/oprofile/org.eclipse.linuxtools.oprofile.doc/pom.xml index f026e32f5c..5ce46c7158 100644 --- a/oprofile/org.eclipse.linuxtools.oprofile.doc/pom.xml +++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/pom.xml @@ -1,6 +1,6 @@ - - - - - - - - diff --git a/perf/org.eclipse.linuxtools.perf.doc/pom.xml b/perf/org.eclipse.linuxtools.perf.doc/pom.xml index 58e39dcfe9..47dc40b008 100644 --- a/perf/org.eclipse.linuxtools.perf.doc/pom.xml +++ b/perf/org.eclipse.linuxtools.perf.doc/pom.xml @@ -23,5 +23,24 @@ eclipse-plugin Linux Tools Perf Documentation Plug-in + + + + regenHelp + + + + maven-antrun-plugin + + + helpdocs + generate-resources + + + + + + + diff --git a/pom.xml b/pom.xml index a9df0d4888..40ace04058 100644 --- a/pom.xml +++ b/pom.xml @@ -230,6 +230,42 @@ + + regenHelp + + + + + maven-antrun-plugin + + + helpdocs + + + + + + + + + run + + + + + + org.eclipse.mylyn.docs + org.eclipse.mylyn.wikitext.mediawiki.ant + 3.0.8 + + + + + + + diff --git a/profiling/org.eclipse.linuxtools.profiling.docs/build-helper.xml b/profiling/org.eclipse.linuxtools.profiling.docs/build-helper.xml index fc43286b4c..d9ca93b609 100644 --- a/profiling/org.eclipse.linuxtools.profiling.docs/build-helper.xml +++ b/profiling/org.eclipse.linuxtools.profiling.docs/build-helper.xml @@ -16,16 +16,6 @@ - - - - - - - - - - diff --git a/profiling/org.eclipse.linuxtools.profiling.docs/pom.xml b/profiling/org.eclipse.linuxtools.profiling.docs/pom.xml index e598ea14a3..64c8cad142 100644 --- a/profiling/org.eclipse.linuxtools.profiling.docs/pom.xml +++ b/profiling/org.eclipse.linuxtools.profiling.docs/pom.xml @@ -28,4 +28,22 @@ Linux Tools Profiling Framework Documentation Plug-in + + + regenHelp + + + + maven-antrun-plugin + + + helpdocs + generate-resources + + + + + + + diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/pom.xml b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/pom.xml index 3a6906a0c7..c161b73172 100644 --- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/pom.xml +++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/pom.xml @@ -34,27 +34,8 @@ helpdocs generate-resources - - - - - - - - - run - - - - org.eclipse.mylyn.docs - org.eclipse.mylyn.wikitext.mediawiki.ant - 3.0.7 - - diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/build-doc.xml b/systemtap/org.eclipse.linuxtools.callgraph.docs/build-doc.xml deleted file mode 100644 index 4b6161bf65..0000000000 --- a/systemtap/org.eclipse.linuxtools.callgraph.docs/build-doc.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Generate Eclipse help content from the Eclipsepedia wiki - - - - - - - - - - - - - - - - - - - - - - = 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/Callgraph/User_Guide . - - - - - - - -Validating help content XML and HTML files: The Eclipse help system expects well-formed XML - -If validation fails it is because either: - -* the userguide source code is poorly formed, or -* the WikiText MediaWiki parser has a bug - -Problems with userguide source are usually caused by improper use of HTML markup in the MediaWiki source, -or inadvertently starting a line with a space character (in MediaWiki this starts a preformatted block) - - - - - - - - - - - - - diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/build-helper.xml b/systemtap/org.eclipse.linuxtools.callgraph.docs/build-helper.xml new file mode 100644 index 0000000000..fc6bb52ec2 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/build-helper.xml @@ -0,0 +1,62 @@ + + + + + + Generate Eclipse help content from the Eclipsepedia wiki + + + + + + + + + + + + = 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/Callgraph/User_Guide . + + + + + + + +Validating help content XML and HTML files: The Eclipse help system expects well-formed XML + +If validation fails it is because either: + +* the userguide source code is poorly formed, or +* the WikiText MediaWiki parser has a bug + +Problems with userguide source are usually caused by improper use of HTML markup in the MediaWiki source, +or inadvertently starting a line with a space character (in MediaWiki this starts a preformatted block) + + + + + + + + + + + + + diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/pom.xml b/systemtap/org.eclipse.linuxtools.callgraph.docs/pom.xml index 33f2b19401..cb6d1f81ed 100644 --- a/systemtap/org.eclipse.linuxtools.callgraph.docs/pom.xml +++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/pom.xml @@ -1,6 +1,6 @@ - - - - - - - - diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/pom.xml b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/pom.xml index 3e45e456ac..959d21792b 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/pom.xml +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/pom.xml @@ -1,6 +1,6 @@ - - - - - - - diff --git a/vagrant/org.eclipse.linuxtools.vagrant.docs/pom.xml b/vagrant/org.eclipse.linuxtools.vagrant.docs/pom.xml index 9b45b9cdbd..7603eceb31 100644 --- a/vagrant/org.eclipse.linuxtools.vagrant.docs/pom.xml +++ b/vagrant/org.eclipse.linuxtools.vagrant.docs/pom.xml @@ -1,6 +1,6 @@ - - - - - - - - diff --git a/valgrind/org.eclipse.linuxtools.valgrind.doc/pom.xml b/valgrind/org.eclipse.linuxtools.valgrind.doc/pom.xml index dc5700c0ad..56661007ce 100644 --- a/valgrind/org.eclipse.linuxtools.valgrind.doc/pom.xml +++ b/valgrind/org.eclipse.linuxtools.valgrind.doc/pom.xml @@ -1,6 +1,6 @@