You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2017/12/20 09:26:45 UTC
[maven-ant-plugin] 27/50: MANT-15: Review plugin documentation
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to annotated tag maven-ant-plugin-2.0
in repository https://gitbox.apache.org/repos/asf/maven-ant-plugin.git
commit cf39c52c7d613e2bf7b07ef7a00723bffb8e402b
Author: Vincent Siveton <vs...@apache.org>
AuthorDate: Sun Sep 24 13:56:54 2006 +0000
MANT-15: Review plugin documentation
o added documentation
o Updated pom to add prerequisite
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-ant-plugin@449405 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 3 ++
src/site/apt/examples/using.apt | 65 ++++++++++++++++++++++++++++
src/site/apt/index.apt | 45 +++++++++++++++++++
src/site/apt/usage.apt | 96 +++++++++++++++++++++++++++++++++++++++++
src/site/fml/faq.fml | 30 +++++++++++++
src/site/site.xml | 47 ++++++++++++++++++++
6 files changed, 286 insertions(+)
diff --git a/pom.xml b/pom.xml
index 3bb8250..f0ff565 100644
--- a/pom.xml
+++ b/pom.xml
@@ -29,6 +29,9 @@
<packaging>maven-plugin</packaging>
<name>Maven Ant Plugin</name>
<version>2.0-beta-2-SNAPSHOT</version>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
<issueManagement>
<system>jira</system>
<url>http://jira.codehaus.org/browse/MANT</url>
diff --git a/src/site/apt/examples/using.apt b/src/site/apt/examples/using.apt
new file mode 100644
index 0000000..430d356
--- /dev/null
+++ b/src/site/apt/examples/using.apt
@@ -0,0 +1,65 @@
+ ------
+ Grammar Inheritance
+ ------
+ Vincent Siveton
+ ------
+ September 2006
+ ------
+
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~~ you may not use this file except in compliance with the License.
+ ~~ You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing, software
+ ~~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~~ See the License for the specific language governing permissions and
+ ~~ limitations under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
+Using generated Ant build files
+
+ <<Note>>: You should update the <<<build.xml>>> and <<NOT>> the <<<maven-build.xml>>>.
+
+ The <<<build.xml>>> uses the {{{http://ant.apache.org/manual/CoreTasks/import.html}import task}} of Ant.
+ So, you could overwrite generated targets in the <<<build.xml>>>. For instance:
+
++-----+
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- ====================================================================== -->
+<!-- Ant build file (http://ant.apache.org/) for Ant 1.6.2 or above. -->
+<!-- ====================================================================== -->
+
+<project name="%PROJECT_ARTIFACTID%" default="jar" basedir=".">
+
+ <!-- ====================================================================== -->
+ <!-- Import maven-build.xml into the current project -->
+ <!-- ====================================================================== -->
+
+ <import file="maven-build.xml"/>
+
+ <!-- ====================================================================== -->
+ <!-- Help target -->
+ <!-- ====================================================================== -->
+
+ <target name="help">
+ <echo message="Please run: $ant -projecthelp"/>
+ </target>
+
+ <!-- ====================================================================== -->
+ <!-- Overwrite the jar target from maven-build.xml -->
+ <!-- ====================================================================== -->
+
+ <target name="jar">
+ <echo message="Nothing to do."/>
+ </target>
+</project>
++-----+
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
new file mode 100644
index 0000000..9b882f7
--- /dev/null
+++ b/src/site/apt/index.apt
@@ -0,0 +1,45 @@
+ ------
+ Introduction
+ ------
+ Vincent Siveton
+ ------
+ September 2006
+ ------
+
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~~ you may not use this file except in compliance with the License.
+ ~~ You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing, software
+ ~~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~~ See the License for the specific language governing permissions and
+ ~~ limitations under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
+Maven 2 Ant Plugin
+
+ The Ant Plugin generates {{{http://ant.apache.org/}Ant}} build files for Ant 1.6.2 or above.
+
+* Goals Overview
+
+ The Ant Plugin has one goal:
+
+ * {{{ant-mojo.html}ant:ant}} Generate Ant build files.
+
+* Usage
+
+ Instructions on how to use the Ant Plugin can be found {{{usage.html}here}}.
+
+* Examples
+
+ The following examples show how to use the Ant Plugin in more advanced usecases:
+
+ * {{{examples/using.html}Using generated Ant build files}}
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
new file mode 100644
index 0000000..e8b92cd
--- /dev/null
+++ b/src/site/apt/usage.apt
@@ -0,0 +1,96 @@
+ ------
+ Usage
+ ------
+ Vincent Siveton
+ ------
+ September 2006
+ ------
+
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~~ you may not use this file except in compliance with the License.
+ ~~ You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing, software
+ ~~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~~ See the License for the specific language governing permissions and
+ ~~ limitations under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
+Usage
+
+ The Ant Plugin generates Ant build files. The following example describe the basic
+ usage of the Plugin.
+
+* Generate Ant build files
+
+ To generate files, you should execute the ant goal of the Ant Plugin, i.e.:
+
++-----+
+mvn ant:ant
++-----+
+
+ The following files should be created:
+
++-----+
+yourProjectBaseDir
+ |-- build.xml
+ `-- maven-build.xml
+ `-- maven-build.properties
++-----+
+
+** build.xml
+
+ The <<<build.xml>>> is a generic Ant build file. It could be updated by the user. Here is the out-of-box <<<build.xml>>>:
+
++-----+
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- ====================================================================== -->
+<!-- Ant build file (http://ant.apache.org/) for Ant 1.6.2 or above. -->
+<!-- ====================================================================== -->
+
+<project name="%PROJECT_ARTIFACTID%" default="jar" basedir=".">
+
+ <!-- ====================================================================== -->
+ <!-- Import maven-build.xml into the current project -->
+ <!-- ====================================================================== -->
+
+ <import file="maven-build.xml"/>
+
+ <!-- ====================================================================== -->
+ <!-- Help target -->
+ <!-- ====================================================================== -->
+
+ <target name="help">
+ <echo message="Please run: $ant -projecthelp"/>
+ </target>
+</project>
++-----+
+
+ <<Note>>: By default, the <<<build.xml>>> is not overwrited when calling <<<mvn ant:ant>>>. If you want to overwrite it,
+ you should execute the ant goal with the <<<overwrite>>> parameter, i.e.:
+
++-----+
+mvn ant:ant -Doverwrite=true
++-----+
+
+** maven-build.xml
+
+ The <<<maven-build.xml>>> is an Ant build file for the Maven project. It contains several targets to clean, compile,
+ test and packaging the Ant project.
+
+ <<Note>>: <<DO NOT EDIT maven-build.xml!>> It could be overwrite when calling <<<mvn ant:ant>>>.
+
+** maven-build.properties
+
+ The <<<maven-build.properties>>> contains several properties used by the <<<maven-build.xml>>> build file.
+
+ <<Note>>: <<DO NOT EDIT maven-build.properties!>> It could be overwrite when calling <<<mvn ant:ant>>>.
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
new file mode 100644
index 0000000..e645c5d
--- /dev/null
+++ b/src/site/fml/faq.fml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+
+<!--
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="Where are the generated Ant build files">
+ <question>Where are the generated Ant build files?</question>
+ <answer>
+ <p>
+ The files are generated in the Maven <i>${basedir}</i> directory.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
diff --git a/src/site/site.xml b/src/site/site.xml
new file mode 100644
index 0000000..c254b00
--- /dev/null
+++ b/src/site/site.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
+<project name="Maven 2 Ant Plugin">
+ <bannerLeft>
+ <name>Maven 2 Ant Plugin</name>
+ <src>http://maven.apache.org/images/apache-maven-project.png</src>
+ <href>http://maven.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight>
+ <body>
+ <links>
+ <item name="Maven" href="http://maven.apache.org/"/>
+ <item name="Ant" href="http://ant.apache.org/"/>
+ </links>
+
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
+ <item name="FAQ" href="faq.html"/>
+ </menu>
+
+ <menu name="Examples">
+ <item name="Using Ant build files" href="/examples/using.html"/>
+ </menu>
+
+ ${reports}
+ </body>
+</project>
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.