mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-06-08 02:06:01 +02:00
Stop synchronizing user guides from Wiki
The primary location for these user guides is now the Git repo in HTML format. Part of #32
This commit is contained in:
Jonah Graham
parent
dcea86c4a2
commit
15ee18e027
7 changed files with 6 additions and 219 deletions
13
BUILDING.md
13
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
|
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.
|
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
|
#### jniheaders
|
||||||
|
|
||||||
The `jniheaders` profile can be used on the `core/org.eclipse.cdt.core.native` and
|
The `jniheaders` profile can be used on the `core/org.eclipse.cdt.core.native` and
|
||||||
|
|
|
||||||
|
|
@ -26,9 +26,9 @@
|
||||||
</tr>
|
</tr>
|
||||||
</table><hr class="navigation-separator"/>
|
</table><hr class="navigation-separator"/>
|
||||||
<h1 id="Updating_This_Document">Updating This Document</h1>
|
<h1 id="Updating_This_Document">Updating This Document</h1>
|
||||||
<p>This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit
|
<p>This document is maintained in Git. Please see provide a Pull Request following the <a
|
||||||
|
href="https://github.com/eclipse-cdt/cdt/blob/main/CONTRIBUTING.md">Eclipse CDT contribution guide</a> to <a
|
||||||
<a href="https://wiki.eclipse.org/CDT/Autotools/User_Guide">https://wiki.eclipse.org/CDT/Autotools/User_Guide</a>
|
href="org.eclipse.cdt.autotools.docs">https://github.com/eclipse-cdt/cdt/tree/main/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide</a>
|
||||||
</p><hr class="navigation-separator"/>
|
</p><hr class="navigation-separator"/>
|
||||||
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
|
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
|
||||||
<tr>
|
<tr>
|
||||||
|
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!--
|
|
||||||
Copyright (c) 2012, 2018 Red Hat, Inc.
|
|
||||||
This program and the accompanying materials
|
|
||||||
are made available under the terms of the Eclipse Public License 2.0
|
|
||||||
which accompanies this distribution, and is available at
|
|
||||||
https://www.eclipse.org/legal/epl-2.0/
|
|
||||||
|
|
||||||
SPDX-License-Identifier: EPL-2.0
|
|
||||||
|
|
||||||
Contributors:
|
|
||||||
Red Hat - initial API and implementation
|
|
||||||
-->
|
|
||||||
<project name="org.eclipse.cdt.autotools.docs" default="all">
|
|
||||||
<description>
|
|
||||||
Generate Eclipse help content for the CDT autotools user guide
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<property name="autotools.help.doc.url.base" value="https://wiki.eclipse.org"/>
|
|
||||||
<property name="autotools.wiki.url.base" value="${autotools.help.doc.url.base}/CDT/Autotools"/>
|
|
||||||
<property name="imageFolder" value="images"/>
|
|
||||||
|
|
||||||
<target name="all" description="Generate Eclipse help content for the CDT Autotools user guide">
|
|
||||||
<mediawiki-to-eclipse-help wikiBaseUrl="${autotools.help.doc.url.base}" title="Autotools Plug-in User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
|
|
||||||
|
|
||||||
<path name="CDT/Autotools/User_Guide" title="Autotools Plug-in User Guide" 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
|
|
||||||
https://wiki.eclipse.org/CDT/Autotools/User_Guide
|
|
||||||
</pageAppendum>
|
|
||||||
</mediawiki-to-eclipse-help>
|
|
||||||
<replace file="CDT/Autotools/User_Guide/User-Guide.html" token="{{#eclipseproject:tools.cdt}}" value=""/>
|
|
||||||
<antcall target="test" />
|
|
||||||
</target>
|
|
||||||
|
|
||||||
<target name="test" description="verify that all of the HTML files are well-formed XML">
|
|
||||||
<echo level="info">
|
|
||||||
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)
|
|
||||||
</echo>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Don't bother with DTD validation: we only care if the files are well-formed.
|
|
||||||
We therefore provide an empty DTD
|
|
||||||
-->
|
|
||||||
<echo file="tmp/__empty.dtd" message="" />
|
|
||||||
<xmlvalidate lenient="true">
|
|
||||||
<fileset dir="CDT">
|
|
||||||
<include name="**/*.html" />
|
|
||||||
</fileset>
|
|
||||||
<dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="${basedir}/tmp/__empty.dtd" />
|
|
||||||
</xmlvalidate>
|
|
||||||
<delete dir="tmp"/>
|
|
||||||
</target>
|
|
||||||
</project>
|
|
||||||
|
|
@ -87,41 +87,6 @@
|
||||||
</plugins>
|
</plugins>
|
||||||
</build>
|
</build>
|
||||||
</profile>
|
</profile>
|
||||||
<profile>
|
|
||||||
<id>regenHelp</id>
|
|
||||||
<build>
|
|
||||||
<plugins>
|
|
||||||
<plugin>
|
|
||||||
<artifactId>maven-antrun-plugin</artifactId>
|
|
||||||
<executions>
|
|
||||||
<execution>
|
|
||||||
<id>helpdocs</id>
|
|
||||||
<phase>generate-resources</phase>
|
|
||||||
<configuration>
|
|
||||||
<target>
|
|
||||||
<taskdef classpathref="maven.plugin.classpath"
|
|
||||||
resource="org/eclipse/mylyn/wikitext/mediawiki/ant/tasks.properties" />
|
|
||||||
<taskdef classpathref="maven.plugin.classpath"
|
|
||||||
resource="org/eclipse/mylyn/wikitext/ant/tasks.properties" />
|
|
||||||
<ant antfile="build-helper.xml" target="all" />
|
|
||||||
</target>
|
|
||||||
</configuration>
|
|
||||||
<goals>
|
|
||||||
<goal>run</goal>
|
|
||||||
</goals>
|
|
||||||
</execution>
|
|
||||||
</executions>
|
|
||||||
<dependencies>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.eclipse.mylyn.docs</groupId>
|
|
||||||
<artifactId>org.eclipse.mylyn.wikitext.mediawiki.ant</artifactId>
|
|
||||||
<version>3.0.25</version>
|
|
||||||
</dependency>
|
|
||||||
</dependencies>
|
|
||||||
</plugin>
|
|
||||||
</plugins>
|
|
||||||
</build>
|
|
||||||
</profile>
|
|
||||||
<profile>
|
<profile>
|
||||||
<id>fake-doc</id>
|
<id>fake-doc</id>
|
||||||
<activation>
|
<activation>
|
||||||
|
|
|
||||||
|
|
@ -26,9 +26,9 @@
|
||||||
</tr>
|
</tr>
|
||||||
</table><hr class="navigation-separator"/>
|
</table><hr class="navigation-separator"/>
|
||||||
<h1 id="Updating_This_Document">Updating This Document</h1>
|
<h1 id="Updating_This_Document">Updating This Document</h1>
|
||||||
<p>This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit
|
<p>This document is maintained in Git. Please see provide a Pull Request following the <a
|
||||||
|
href="https://github.com/eclipse-cdt/cdt/blob/main/CONTRIBUTING.md">Eclipse CDT contribution guide</a> to <a
|
||||||
<a href="https://wiki.eclipse.org/CDT/Meson/User_Guide">https://wiki.eclipse.org/CDT/Meson/User_Guide</a>
|
href="org.eclipse.cdt.autotools.docs">https://github.com/eclipse-cdt/cdt/tree/main/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/</a>
|
||||||
</p><hr class="navigation-separator"/>
|
</p><hr class="navigation-separator"/>
|
||||||
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
|
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
|
||||||
<tr>
|
<tr>
|
||||||
|
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!--
|
|
||||||
Copyright (c) 2018 Red Hat, Inc.
|
|
||||||
This program and the accompanying materials
|
|
||||||
are made available under the terms of the Eclipse Public License 2.0
|
|
||||||
which accompanies this distribution, and is available at
|
|
||||||
https://www.eclipse.org/legal/epl-2.0/
|
|
||||||
|
|
||||||
SPDX-License-Identifier: EPL-2.0
|
|
||||||
|
|
||||||
Contributors:
|
|
||||||
Red Hat - initial API and implementation
|
|
||||||
-->
|
|
||||||
<project name="org.eclipse.cdt.meson.docs" default="all">
|
|
||||||
<description>
|
|
||||||
Generate Eclipse help content for the CDT meson user guide
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<property name="meson.help.doc.url.base" value="http://wiki.eclipse.org"/>
|
|
||||||
<property name="meson.wiki.url.base" value="${meson.help.doc.url.base}/CDT/Meson"/>
|
|
||||||
<property name="imageFolder" value="images"/>
|
|
||||||
|
|
||||||
<target name="all" description="Generate Eclipse help content for the CDT Meson user guide">
|
|
||||||
<mediawiki-to-eclipse-help wikiBaseUrl="${meson.help.doc.url.base}" title="Meson Plug-in User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
|
|
||||||
|
|
||||||
<path name="CDT/Meson/User_Guide" title="Meson Plug-in User Guide" 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
|
|
||||||
https://wiki.eclipse.org/CDT/Meson/User_Guide
|
|
||||||
</pageAppendum>
|
|
||||||
</mediawiki-to-eclipse-help>
|
|
||||||
<replace file="CDT/Meson/User_Guide/User-Guide.html" token="{{#eclipseproject:tools.cdt}}" value=""/>
|
|
||||||
<antcall target="test" />
|
|
||||||
</target>
|
|
||||||
|
|
||||||
<target name="test" description="verify that all of the HTML files are well-formed XML">
|
|
||||||
<echo level="info">
|
|
||||||
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)
|
|
||||||
</echo>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Don't bother with DTD validation: we only care if the files are well-formed.
|
|
||||||
We therefore provide an empty DTD
|
|
||||||
-->
|
|
||||||
<echo file="tmp/__empty.dtd" message="" />
|
|
||||||
<xmlvalidate lenient="true">
|
|
||||||
<fileset dir="CDT">
|
|
||||||
<include name="**/*.html" />
|
|
||||||
</fileset>
|
|
||||||
<dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="${basedir}/tmp/__empty.dtd" />
|
|
||||||
</xmlvalidate>
|
|
||||||
<delete dir="tmp"/>
|
|
||||||
</target>
|
|
||||||
</project>
|
|
||||||
|
|
@ -87,41 +87,6 @@
|
||||||
</plugins>
|
</plugins>
|
||||||
</build>
|
</build>
|
||||||
</profile>
|
</profile>
|
||||||
<profile>
|
|
||||||
<id>regenHelp</id>
|
|
||||||
<build>
|
|
||||||
<plugins>
|
|
||||||
<plugin>
|
|
||||||
<artifactId>maven-antrun-plugin</artifactId>
|
|
||||||
<executions>
|
|
||||||
<execution>
|
|
||||||
<id>helpdocs</id>
|
|
||||||
<phase>generate-resources</phase>
|
|
||||||
<configuration>
|
|
||||||
<target>
|
|
||||||
<taskdef classpathref="maven.plugin.classpath"
|
|
||||||
resource="org/eclipse/mylyn/wikitext/mediawiki/ant/tasks.properties" />
|
|
||||||
<taskdef classpathref="maven.plugin.classpath"
|
|
||||||
resource="org/eclipse/mylyn/wikitext/ant/tasks.properties" />
|
|
||||||
<ant antfile="build-helper.xml" target="all" />
|
|
||||||
</target>
|
|
||||||
</configuration>
|
|
||||||
<goals>
|
|
||||||
<goal>run</goal>
|
|
||||||
</goals>
|
|
||||||
</execution>
|
|
||||||
</executions>
|
|
||||||
<dependencies>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.eclipse.mylyn.docs</groupId>
|
|
||||||
<artifactId>org.eclipse.mylyn.wikitext.mediawiki.ant</artifactId>
|
|
||||||
<version>3.0.23</version>
|
|
||||||
</dependency>
|
|
||||||
</dependencies>
|
|
||||||
</plugin>
|
|
||||||
</plugins>
|
|
||||||
</build>
|
|
||||||
</profile>
|
|
||||||
<profile>
|
<profile>
|
||||||
<id>fake-doc</id>
|
<id>fake-doc</id>
|
||||||
<activation>
|
<activation>
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue