servicemix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chir...@apache.org
Subject svn commit: r681988 - in /servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site: ./ apt/ apt/index.apt apt/usage.apt site.xml
Date Sat, 02 Aug 2008 14:35:47 GMT
Author: chirino
Date: Sat Aug  2 07:35:46 2008
New Revision: 681988

URL: http://svn.apache.org/viewvc?rev=681988&view=rev
Log:
adding a little doco

Added:
    servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/
    servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/
    servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/index.apt
    servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/usage.apt
    servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/site.xml

Added: servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/index.apt?rev=681988&view=auto
==============================================================================
--- servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/index.apt (added)
+++ servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/index.apt Sat Aug  2
07:35:46 2008
@@ -0,0 +1,43 @@
+ ------
+ Introduction
+ ------
+ Hiram Chirino
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you 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.
+
+Maven 2 Checksum Plugin
+
+ This plugin provides the capability validate and generate checksums
+ of the project dependencies against a checksum file that is included
+ as part of the project.
+
+* Goals Overview
+
+  The Checksum Plugin has two goals:
+
+  * {{{generate-checksums-mojo.html}checksum-maven-plugin:generate-checksums}} is bound to
the <<<compile>>> phase and
+  is used to generate the checksum.txt file.
+
+  * {{{validate-checksums-mojo.html}checksum-maven-plugin:validate-checksums}} is bound to
the <<<process-classes>>> phase and
+  is used to validate the Project dependencies against the checksum.txt file.
+
+* Usage
+
+  Instructions on how to use the Checksum Plugin can be found in the
+  {{{usage.html}usage}} page.

Added: servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/usage.apt?rev=681988&view=auto
==============================================================================
--- servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/usage.apt (added)
+++ servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/apt/usage.apt Sat Aug  2
07:35:46 2008
@@ -0,0 +1,59 @@
+ ------
+ Usage
+ ------
+ Hiram Chirino
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you 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.
+
+Usage
+
+* Validating the Dependency Checksums
+
+  The goals for the Validate goal are bound to the <<<process-classes>>>
phase in the
+  build lifecycle.  
+
++-----
+mvn package
++-----
+
+* Configuring Your Checksum Plugin
+
++-----
+<project>
+  ...
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.servicemix.tooling</groupId>
+        <artifactId>checksum-maven-plugin</artifactId>
+        <version>1.0-SNAPSHOT</version>
+		    <executions>
+          <execution>
+            <id>validate-checksums</id>
+            <goals>
+              <goal>validate-checksums</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+  ...
+</project>
++-----

Added: servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/site.xml?rev=681988&view=auto
==============================================================================
--- servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/site.xml (added)
+++ servicemix/maven-plugins/checksum-maven-plugin/trunk/src/site/site.xml Sat Aug  2 07:35:46
2008
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you 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 Shade Plugin">
+  <body>
+    <menu name="Overview">
+      <item name="Introduction" href="index.html"/>
+      <item name="Goals" href="plugin-info.html"/>
+      <item name="Usage" href="usage.html"/>
+    </menu>
+  </body>
+</project>



Mime
View raw message