From 15ee18e027044bbd19a08167926869e65bcc5083 Mon Sep 17 00:00:00 2001 From: Jonah Graham Date: Wed, 9 Nov 2022 09:57:55 -0500 Subject: [PATCH] Stop synchronizing user guides from Wiki The primary location for these user guides is now the Git repo in HTML format. Part of #32 --- BUILDING.md | 13 ---- .../User_Guide/Updating-This-Document.html | 6 +- .../build-helper.xml | 65 ------------------- build/org.eclipse.cdt.autotools.docs/pom.xml | 35 ---------- .../User_Guide/Updating-This-Document.html | 6 +- .../build-helper.xml | 65 ------------------- build/org.eclipse.cdt.meson.docs/pom.xml | 35 ---------- 7 files changed, 6 insertions(+), 219 deletions(-) delete mode 100644 build/org.eclipse.cdt.autotools.docs/build-helper.xml delete mode 100644 build/org.eclipse.cdt.meson.docs/build-helper.xml diff --git a/BUILDING.md b/BUILDING.md index 7172b4b5619..871a098287e 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -62,19 +62,6 @@ Requires verify phase of maven to run, i.e. will not run with `mvn package` even Runs the production steps of the build. This profile can only be run on the CDT CI machines as access to Eclipse key signing server is needed to sign the jars. -#### regenHelp - -Some of the help systems in Eclipse CDT require the `regenHelp` profile to rebuild their HTML from the source documents. For example, to regenerate the help -for Autotools or Meson do: - -``` -mvn generate-resources -DuseSimrelRepo -f build/org.eclipse.cdt.meson.docs -PregenHelp -``` - -``` -mvn generate-resources -DuseSimrelRepo -f build/org.eclipse.cdt.autotools.docs -PregenHelp -``` - #### jniheaders The `jniheaders` profile can be used on the `core/org.eclipse.cdt.core.native` and diff --git a/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Updating-This-Document.html b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Updating-This-Document.html index be97848ade2..7e955887369 100644 --- a/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Updating-This-Document.html +++ b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Updating-This-Document.html @@ -26,9 +26,9 @@

Updating This Document

-

This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit - - https://wiki.eclipse.org/CDT/Autotools/User_Guide +

This document is maintained in Git. Please see provide a Pull Request following the Eclipse CDT contribution guide to https://github.com/eclipse-cdt/cdt/tree/main/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide

diff --git a/build/org.eclipse.cdt.autotools.docs/build-helper.xml b/build/org.eclipse.cdt.autotools.docs/build-helper.xml deleted file mode 100644 index 17fa72e1d7e..00000000000 --- a/build/org.eclipse.cdt.autotools.docs/build-helper.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Generate Eclipse help content for the CDT autotools user guide - - - - - - - - - - - - -= Updating This Document = - -This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit -https://wiki.eclipse.org/CDT/Autotools/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/build/org.eclipse.cdt.autotools.docs/pom.xml b/build/org.eclipse.cdt.autotools.docs/pom.xml index 88e5b6c4241..dc6f395604a 100644 --- a/build/org.eclipse.cdt.autotools.docs/pom.xml +++ b/build/org.eclipse.cdt.autotools.docs/pom.xml @@ -87,41 +87,6 @@ - - regenHelp - - - - maven-antrun-plugin - - - helpdocs - generate-resources - - - - - - - - - run - - - - - - org.eclipse.mylyn.docs - org.eclipse.mylyn.wikitext.mediawiki.ant - 3.0.25 - - - - - - fake-doc diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Updating-This-Document.html b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Updating-This-Document.html index 8db463650cf..e45b2ee6c32 100644 --- a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Updating-This-Document.html +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Updating-This-Document.html @@ -26,9 +26,9 @@

Updating This Document

-

This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit - - https://wiki.eclipse.org/CDT/Meson/User_Guide +

This document is maintained in Git. Please see provide a Pull Request following the Eclipse CDT contribution guide to https://github.com/eclipse-cdt/cdt/tree/main/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/

diff --git a/build/org.eclipse.cdt.meson.docs/build-helper.xml b/build/org.eclipse.cdt.meson.docs/build-helper.xml deleted file mode 100644 index d013909f9a3..00000000000 --- a/build/org.eclipse.cdt.meson.docs/build-helper.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Generate Eclipse help content for the CDT meson user guide - - - - - - - - - - - - -= Updating This Document = - -This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit -https://wiki.eclipse.org/CDT/Meson/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/build/org.eclipse.cdt.meson.docs/pom.xml b/build/org.eclipse.cdt.meson.docs/pom.xml index 3473800753b..1365b72d9c9 100644 --- a/build/org.eclipse.cdt.meson.docs/pom.xml +++ b/build/org.eclipse.cdt.meson.docs/pom.xml @@ -87,41 +87,6 @@ - - regenHelp - - - - maven-antrun-plugin - - - helpdocs - generate-resources - - - - - - - - - run - - - - - - org.eclipse.mylyn.docs - org.eclipse.mylyn.wikitext.mediawiki.ant - 3.0.23 - - - - - - fake-doc