Author: dennisl
Date: Sat Jul 29 16:13:30 2006
New Revision: 426848
URL: http://svn.apache.org/viewvc?rev=426848&view=rev
Log:
o Generate xdoc for verifications.mdo and add it to the site.
o Expand some of the texts.
o Fix titles and headings.
o Add banners and project name to site.xml.
o Rename example file.
o Fix typos and broken links.
Added:
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/sample-verifications.apt
(contents, props changed)
- copied, changed from r426840,
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/simple.apt
Removed:
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/simple.apt
Modified:
maven/plugins/trunk/maven-verifier-plugin/pom.xml
maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java
maven/plugins/trunk/maven-verifier-plugin/src/main/mdo/verifications.mdo
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-verifier-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-verifier-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/pom.xml?rev=426848&r1=426847&r2=426848&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-verifier-plugin/pom.xml Sat Jul 29 16:13:30 2006
@@ -1,8 +1,25 @@
-<project>
+<!--
+ ~ Copyright 2005-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 xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd";>
<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-verifier-plugin</artifactId>
@@ -23,7 +40,7 @@
<subscribe>[EMAIL PROTECTED]</subscribe>
<unsubscribe>[EMAIL PROTECTED]</unsubscribe>
<post>users@maven.apache.org</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-users</archive>
+ <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>
@@ -34,16 +51,15 @@
<subscribe>[EMAIL PROTECTED]</subscribe>
<unsubscribe>[EMAIL PROTECTED]</unsubscribe>
<post>dev@maven.apache.org</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-dev</archive>
+ <archive>http://mail-archives.apache.org/mod_mbox/maven-dev/</archive>
</mailingList>
<mailingList>
<name>Maven Commits List</name>
<subscribe>[EMAIL PROTECTED]</subscribe>
<unsubscribe>[EMAIL PROTECTED]</unsubscribe>
<post>commits@maven.apache.org</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-dev</archive>
+
<archive>http://mail-archives.apache.org/mod_mbox/maven-commits/</archive>
</mailingList>
- <!-- duplication from maven-parent pom - temporary until they inherit
properly -->
<mailingList>
<name>Maven Announcements List</name>
<post>announce@maven.apache.org</post>
@@ -77,6 +93,14 @@
<goal>xpp3-reader</goal>
<goal>xpp3-writer</goal>
<goal>java</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>site-docs</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>xdoc</goal>
+ <goal>xsd</goal>
</goals>
</execution>
</executions>
Modified:
maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java?rev=426848&r1=426847&r2=426848&view=diff
==============================================================================
---
maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java
(original)
+++
maven/plugins/trunk/maven-verifier-plugin/src/main/java/org/apache/maven/plugin/verifier/VerifierMojo.java
Sat Jul 29 16:13:30 2006
@@ -32,7 +32,7 @@
import java.util.regex.Pattern;
/**
- * Verifies existence or non-existence of files/directories an optionally
checks file content against a regexp.
+ * Verifies the existence or non-existence of files/directories and optionally
checks file content against a regexp.
*
* @goal verify
* @phase integration-test
@@ -44,7 +44,7 @@
extends AbstractMojo
{
/**
- * Project base directory (appended for relative file paths).
+ * Project base directory (prepended for relative file paths).
*
* @parameter expression="${basedir}"
* @required
@@ -60,7 +60,7 @@
private File verificationFile;
/**
- * Wether the build will fail if a file isn't available or not.
+ * Whether the build will fail on verification errors.
*
* @required
*/
Modified:
maven/plugins/trunk/maven-verifier-plugin/src/main/mdo/verifications.mdo
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/main/mdo/verifications.mdo?rev=426848&r1=426847&r2=426848&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/main/mdo/verifications.mdo
(original)
+++ maven/plugins/trunk/maven-verifier-plugin/src/main/mdo/verifications.mdo
Sat Jul 29 16:13:30 2006
@@ -3,7 +3,7 @@
<name>Verifications</name>
<description><![CDATA[
Project-specific configuration file for the Verifier plugin. It contains
- definition of expected files and directories to be checked for after an
+ definitions of the files and directories to be checked after an
integration test has run. It can also check for file content against
regexps.]]></description>
<defaults>
@@ -16,13 +16,13 @@
<class rootElement="true" xml.tagName="verifications">
<name>Verifications</name>
<version>1.0.0</version>
- <description>Root element of the project verification file.</description>
+ <description>Root element of the verifications file.</description>
<fields>
<field>
<name>files</name>
<version>1.0.0</version>
<description><![CDATA[
- List of files and directories to check for.
+ List of files and directories to check.
]]></description>
<association>
<type>File</type>
@@ -53,8 +53,10 @@
<name>exists</name>
<version>1.0.0</version>
<description><![CDATA[
- If true checks for file or directory existence, otherwise checks
that the
- file or directory doesn't exist.
+ When this is set to <code>true</code> the plugin checks that the
+ file or directory exists. When set to <code>false</code> it checks
+ that the file or directory does <strong>not</strong> exist. The
+ default value is <code>true</code>.
]]></description>
<defaultValue>true</defaultValue>
<type>boolean</type>
Copied:
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/sample-verifications.apt
(from r426840,
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/simple.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/sample-verifications.apt?p2=maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/sample-verifications.apt&p1=maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/simple.apt&r1=426840&r2=426848&rev=426848&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/simple.apt
(original)
+++
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/sample-verifications.apt
Sat Jul 29 16:13:30 2006
@@ -1,12 +1,14 @@
------
- Maven 2 Verifier Plugin: Simple example
+ Sample Verifications
------
Denis Cabasson
------
20 july 2006
------
-Sample verifications.xml file
+Sample Verifications
+
+ Here is an example of what a <<<verifications.xml>>> file can look like:
+--------
<verifications>
Propchange:
maven/plugins/trunk/maven-verifier-plugin/src/site/apt/examples/sample-verifications.apt
------------------------------------------------------------------------------
svn:eol-style = native
Modified: maven/plugins/trunk/maven-verifier-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/site/apt/index.apt?rev=426848&r1=426847&r2=426848&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-verifier-plugin/src/site/apt/index.apt Sat Jul 29
16:13:30 2006
@@ -13,17 +13,15 @@
* Goals Overview
- General Information about the goals.
-
- * {{{goal.html}verifier:verify}} Verifies existence or non-existence of
files/directories and optionally checks file content against a regexp.
+ * {{{verify-mojo.html}verifier:verify}} Verifies the existence or
non-existence of files/directories and optionally checks file content against a
regexp.
* Usage
- Instructions on how to use the Plugin Name can be found {{{usage.html}here}}.
+ Instructions on how to use the Verifier Plugin can be found
{{{usage.html}here}}.
* Examples
- To provide you with better understanding on some usages of the Plugin Name,
+ To provide you with better understanding on some usages of the Verifier
Plugin,
you can take a look into the following examples:
- * {{{examples/simple.html}Simple Project}}
+ * {{{examples/sample-verifications.html}Sample Verifications}}
Modified: maven/plugins/trunk/maven-verifier-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/site/apt/usage.apt?rev=426848&r1=426847&r2=426848&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-verifier-plugin/src/site/apt/usage.apt Sat Jul 29
16:13:30 2006
@@ -1,14 +1,18 @@
------
- Maven 2 Verifier Plugin: using
+ Usage
------
Denis Cabasson
------
20 july 2006
------
-Verifying some file system resources during you build
+Usage
- Add the Verifier plugin in your <<<pom.xml>>> under the <<<build>>> section:
+ To verify file system resources during your build, add the Verifier plugin in
+ your <<<pom.xml>>> under the <<<build>>> section. You will also need to
+ create a {{{verifications.html}<<<verifications.xml>>>}} file that contains
+ the verification rules. Add the path to that file to the
+ <<<verificationFile>>> configuration element.
+--------
<project>
@@ -40,4 +44,4 @@
The <<<maven-verifier-plugin>>> will break your build if the files
designated in
the verificationFile cannot be found.
- For a sample verification file, see {{{examples/simple.html}Simple Exemple}}.
+ For a sample verifications file, see
{{{examples/sample-verifications.html}Sample Verifications}}.
Modified: maven/plugins/trunk/maven-verifier-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-verifier-plugin/src/site/site.xml?rev=426848&r1=426847&r2=426848&view=diff
==============================================================================
--- maven/plugins/trunk/maven-verifier-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-verifier-plugin/src/site/site.xml Sat Jul 29
16:13:30 2006
@@ -1,20 +1,47 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<body>
+<!--
+ ~ Copyright 2005-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 Verifier Plugin">
+ <bannerLeft>
+ <name>Maven Verifier 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/maven2/"/>
+ <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
</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="Verifications File Format" href="verifications.html"/>
</menu>
<menu name="Examples">
- <item name="Simple" href="examples/simple.html"/>
+ <item name="Sample Verifications"
href="examples/sample-verifications.html"/>
</menu>
${reports}
-</body>
+ </body>
+</project>
