You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2013/06/20 22:51:39 UTC
svn commit: r1495177 - in
/commons/proper/commons-digest-plugin/trunk/src/site: ./ site.xml xdoc/
xdoc/index.xml
Author: sebb
Date: Thu Jun 20 20:51:39 2013
New Revision: 1495177
URL: http://svn.apache.org/r1495177
Log:
Add a basic site
Added:
commons/proper/commons-digest-plugin/trunk/src/site/
commons/proper/commons-digest-plugin/trunk/src/site/site.xml (with props)
commons/proper/commons-digest-plugin/trunk/src/site/xdoc/
commons/proper/commons-digest-plugin/trunk/src/site/xdoc/index.xml (with props)
Added: commons/proper/commons-digest-plugin/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-digest-plugin/trunk/src/site/site.xml?rev=1495177&view=auto
==============================================================================
--- commons/proper/commons-digest-plugin/trunk/src/site/site.xml (added)
+++ commons/proper/commons-digest-plugin/trunk/src/site/site.xml Thu Jun 20 20:51:39 2013
@@ -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.
+-->
+<!--
+ $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/site/site.xml $
+ $Revision: 1296548 $ $Date: 2012-03-03 01:35:18 +0000 (Sat, 03 Mar 2012) $
+ -->
+<project name="Apache Commons Digest Plugin">
+
+ <body>
+ <menu name="Digest Plugin">
+ <item name="Overview" href="/index.html"/>
+ </menu>
+ </body>
+
+</project>
Propchange: commons/proper/commons-digest-plugin/trunk/src/site/site.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/proper/commons-digest-plugin/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-digest-plugin/trunk/src/site/xdoc/index.xml?rev=1495177&view=auto
==============================================================================
--- commons/proper/commons-digest-plugin/trunk/src/site/xdoc/index.xml (added)
+++ commons/proper/commons-digest-plugin/trunk/src/site/xdoc/index.xml Thu Jun 20 20:51:39 2013
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<!--
+ $HeadURL: https://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/site/xdoc/index.xml $
+ $Revision: 1296463 $ $Date: 2012-03-02 21:08:10 +0000 (Fri, 02 Mar 2012) $
+ -->
+<document>
+
+ <properties>
+ <title>Overview</title>
+ <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
+ </properties>
+
+ <body>
+
+ <section name="Apache Commons Digest Plugin">
+
+ <p>
+ This is a <a href="http://maven.apache.org/">Maven 2.x</a> Plugin which is designed
+ to be used in release profiles for packages such as source and binary archives.
+ </p>
+
+ </section>
+
+ <section name="Plugin Goals">
+ <p>
+ Available Goals:
+ <ul>
+ <li>commons-digest:digest - generate digests (MD5 and SHA1) of specified files</li>
+ <li>commons-digest:help - display the plugin help as per help:describe</li>
+ </ul>
+ </p>
+ </section>
+
+ <section name="Trying out the plugin">
+ <p>
+ Configure the plugin in the <code><build></code> section of the <code>pom.xml</code>
+<source><![CDATA[
+<plugin>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-digest-plugin</artifactId>
+ <version>1.0</version>
+ <configuration>
+ <includes>
+ <include>target/releases/*.zip</include>
+ <include>target/releases/*.tar.gz</include>
+ </includes>
+ <excludes> <!-- Optional -->
+ <exclude>target/release/README*</exclude>
+ </excludes>
+ <createMD5>false</createMD5> <!-- Optional -->
+ <createSHA1>false</createSHA1> <!-- Optional -->
+ <appendFilename>true</appendFilename> <!-- append ' *filename' to the digest file contents -->
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>digest</goal>
+ </goals>
+ <!-- must run after assembly and before deploy -->
+ <phase>verify</phase>
+ </execution>
+ </executions>
+</plugin>
+]]></source>
+ </p>
+ <p>
+ The list of files to process can also be specified on the command line:
+<pre>
+mvn commons-digest:digest -Ddigest.files={comma-separated list of files}
+</pre>
+ Note that the configuration items (apart from includes/excludes) are also supported as
+ properties with the prefix "digest.", so for example the MD5 digest can be omitted by
+ using <code>-Ddigest.createMD5=false</code>
+ </p>
+ </section>
+
+ </body>
+</document>
Propchange: commons/proper/commons-digest-plugin/trunk/src/site/xdoc/index.xml
------------------------------------------------------------------------------
svn:eol-style = native