You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2006/08/01 13:09:38 UTC
svn commit: r427530 - in /maven/plugins/trunk/maven-war-plugin: ./
src/main/java/org/apache/maven/plugin/war/ src/site/ src/site/apt/
src/site/apt/examples/
Author: vsiveton
Date: Tue Aug 1 04:09:37 2006
New Revision: 427530
URL: http://svn.apache.org/viewvc?rev=427530&view=rev
Log:
PR:MWAR-48: review plugin documentation
Submitted by:Franz Allan Valencia See
o Using Maven Plugin Documentation Guidelines
o Removed <mailingLists/> (inherited)
Modified:
maven/plugins/trunk/maven-war-plugin/pom.xml
maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java
maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt
maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt
maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt
maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt
maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt
maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-war-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-war-plugin/pom.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/pom.xml?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-war-plugin/pom.xml Tue Aug 1 04:09:37 2006
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
+ <version>2-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-war-plugin</artifactId>
@@ -16,56 +16,6 @@
<system>JIRA</system>
<url>http://jira.codehaus.org/browse/MWAR</url>
</issueManagement>
- <mailingLists>
- <!-- duplication from maven-plugins pom - temporary until they inherit properly -->
- <mailingList>
- <name>Maven User List</name>
- <subscribe>users-subscribe@maven.apache.org</subscribe>
- <unsubscribe>users-unsubscribe@maven.apache.org</unsubscribe>
- <post>users@maven.apache.org</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-users</archive>
- <otherArchives>
- <otherArchive>http://www.mail-archive.com/users@maven.apache.org/</otherArchive>
- <otherArchive>http://www.nabble.com/Maven---Users-f178.html</otherArchive>
- </otherArchives>
- </mailingList>
- <mailingList>
- <name>Maven Developer List</name>
- <subscribe>dev-subscribe@maven.apache.org</subscribe>
- <unsubscribe>dev-unsubscribe@maven.apache.org</unsubscribe>
- <post>dev@maven.apache.org</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-dev</archive>
- </mailingList>
- <mailingList>
- <name>Maven Commits List</name>
- <subscribe>commits-subscribe@maven.apache.org</subscribe>
- <unsubscribe>commits-unsubscribe@maven.apache.org</unsubscribe>
- <post>commits@maven.apache.org</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-dev</archive>
- </mailingList>
- <!-- duplication from maven-parent pom - temporary until they inherit properly -->
- <mailingList>
- <name>Maven Announcements List</name>
- <post>announce@maven.apache.org</post>
- <subscribe>announce-subscribe@maven.apache.org</subscribe>
- <unsubscribe>announce-unsubscribe@maven.apache.org</unsubscribe>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-announce/</archive>
- </mailingList>
- <mailingList>
- <name>Maven Issues List</name>
- <post>issues@maven.apache.org</post>
- <subscribe>issues-subscribe@maven.apache.org</subscribe>
- <unsubscribe>issues-unsubscribe@maven.apache.org</unsubscribe>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-issues/</archive>
- </mailingList>
- <mailingList>
- <name>Maven Notifications List</name>
- <post>notifications@maven.apache.org</post>
- <subscribe>notifications-subscribe@maven.apache.org</subscribe>
- <unsubscribe>notifications-unsubscribe@maven.apache.org</unsubscribe>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-notifications/</archive>
- </mailingList>
- </mailingLists>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
Modified: maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java (original)
+++ maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java Tue Aug 1 04:09:37 2006
@@ -117,6 +117,8 @@
private Resource[] webResources;
/**
+ * Filters (property files) to include during the interpolation of the pom.xml
+ *
* @parameter expression="${project.build.filters}"
*/
private List filters;
Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt Tue Aug 1 04:09:37 2006
@@ -5,6 +5,23 @@
------
19 June 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
+
Introduction
The default resource directory for all maven2 projects is <<<src/main/resources>>> which
@@ -368,4 +385,4 @@
-
\ No newline at end of file
+
Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt Tue Aug 1 04:09:37 2006
@@ -5,6 +5,23 @@
------
19 June 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
+
Rapid testing with the jetty6 plugin
Normally, testing a web application involves compiling java sources, creating a war and
Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt Tue Aug 1 04:09:37 2006
@@ -5,6 +5,23 @@
------
July 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
+
Creating Skinny WARs
In a typical J2EE environment, a WAR is packaged within an EAR for deployment. The
Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt Tue Aug 1 04:09:37 2006
@@ -5,6 +5,23 @@
------
19 June 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
+
War Manifest Customization
The manifest can be customized by configuring the war plugin's archiver.
@@ -99,4 +116,4 @@
- Check the {{{http://maven.apache.org/guides/mini/guide-manifest.html}Guide to manifest customization}} for more examples.
\ No newline at end of file
+ Check the {{{http://maven.apache.org/guides/mini/guide-manifest.html}Guide to manifest customization}} for more examples.
Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt Tue Aug 1 04:09:37 2006
@@ -5,6 +5,23 @@
------
28 June 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
+
Introduction
Normally all artifact dependencies are collected in <<<WEB-INF/lib>>> except
@@ -184,4 +201,4 @@
[...]
+-----------------+
-
\ No newline at end of file
+
Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt Tue Aug 1 04:09:37 2006
@@ -4,33 +4,60 @@
Pete Marvin King
------
27 June 2006
+ ------
-Overview
+~~ 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 WAR Plugin
The war plugin is responsible for collecting all artifact dependencies, classes
and resources of the web application and packaging them into a web application archive.
-Supported goals
+* Goals Overview
- {{{war-mojo.html}war:war}} is the default goal invoked during the package phase for projects with a package type of war.
+ * {{{war-mojo.html}war:war}} is the default goal invoked during the package phase for projects with a package type of war.
- {{{exploded-mojo.html}war:exploded}} is generally used to speed up testing during the developement phase by creating
+ * {{{exploded-mojo.html}war:exploded}} is generally used to speed up testing during the developement phase by creating
an exploded war on specified directory.
- {{{inplace-mojo.html}war:inplace}} another variation of the war:explode the war is instead generated in the web source directory
+ * {{{inplace-mojo.html}war:inplace}} another variation of the war:explode the war is instead generated in the web source directory
which is <<<src/main/webapp>>> by default.
- See {{{usage.html}usage section}} for the basic usage.
+* Usage
+
+ Instructions on how to use the Maven WAR Plugin can be found {{{usage.html}here}}.
+
+* Examples
-Example configurations :
+ To provide you with better understanding on some usages of the Maven WAR Plugin,
+ you can take a look into the following examples:
- *{{{examples/adding-filtering-webresources.html}Adding and/or filtering webResources}}
+ * {{{examples/adding-filtering-webresources.html}Adding and/or filtering webResources}}
- *{{{examples/war-overlay.html}War overlays}}
+ * {{{examples/war-overlay.html}War overlays}}
+
+ * {{{examples/war-manifest-guide.html}Managing your war manifest}}
+
+ * {{{examples/rapid-testing-jetty6-plugin.html}Rapid testing using jetty6}}
+
+ * {{{examples/skinny-wars.html}Creating skinny wars}}
- *{{{examples/war-manifest-guide.html}Managing your war manifest}}
+* Related links
-Related links
+ * {{{http://maven.apache.org/guides/mini/guide-archive-configuration.html}Exclusion of Maven Descriptors}}
- {{{http://maven.apache.org/guides/mini/guide-archive-configuration.html}Exclusion of Maven Descriptors}}
-
\ No newline at end of file
Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt Tue Aug 1 04:09:37 2006
@@ -5,6 +5,23 @@
------
27 June 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
+
Basic Usage
There are 4 ways to use the war plugin :
Modified: maven/plugins/trunk/maven-war-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/site.xml?rev=427530&r1=427529&r2=427530&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/site.xml Tue Aug 1 04:09:37 2006
@@ -1,22 +1,20 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-/*
- * Copyright 2001-2005 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.
- */
--->
+ ~ 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 War Plugin">
<bannerLeft>