svn commit: r557712 - in /maven/plugins/trunk/maven-changelog-plugin/src/site: apt/examples/using-perforce.apt apt/index.apt site.xml

[de...@apache.org]

Author: dennisl
Date: Thu Jul 19 11:06:42 2007
New Revision: 557712

URL: http://svn.apache.org/viewvc?view=rev&rev=557712
Log:
[MCHANGELOG-66] changelog for perforce fails because of default clientspec

o Document how to configure the plugin when using Perforce.

Added:
    maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/using-perforce.apt
Modified:
    maven/plugins/trunk/maven-changelog-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml

Added: maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/using-perforce.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/using-perforce.apt?view=auto&rev=557712
==============================================================================
--- maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/using-perforce.apt (added)
+++ maven/plugins/trunk/maven-changelog-plugin/src/site/apt/examples/using-perforce.apt Thu Jul 19 11:06:42 2007
@@ -0,0 +1,60 @@
+ ------
+ Using Perforce
+ ------
+ Dennis Lundberg
+ ------
+ 2007-07-19
+ ------
+
+ ~~ 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.
+
+
+Using Perforce
+
+  The maven-changelog-plugin uses {{{http://maven.apache.org/scm/}Maven SCM}}
+  as an underlying layer, when accessing your SCM system. When Maven SCM is
+  working with Perforce it needs a clientspec. This is provided by setting
+  system properties that are then read by Maven SCM.
+
+  Configuring this is done in the same way as for the maven-scm-plugin. So if
+  you have a working configuration for maven-scm-plugin, you can just copy
+  those lines over to your maven-changelog-plugin configuration. The following
+  configuration shows an example of what this can look like.
+
++-----+
+<project>
+  ...
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changelog-plugin</artifactId>
+        <configuration>
+          <systemProperties>
+            <property>
+              <name>maven.scm.perforce.clientspec.name</name>
+              <value>your.perforce.clientspec.name</value>
+            </property>
+          </systemProperties>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
+  ...
+</project>
++-----+

Modified: maven/plugins/trunk/maven-changelog-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/apt/index.apt?view=diff&rev=557712&r1=557711&r2=557712
==============================================================================
--- maven/plugins/trunk/maven-changelog-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-changelog-plugin/src/site/apt/index.apt Thu Jul 19 11:06:42 2007
@@ -61,6 +61,7 @@
 
    * {{{examples/configuration-tag-type.html}Using Tag Type}}
 
+   * {{{examples/using-perforce.html}Using Perforce}}
 
 
 

Modified: maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml?view=diff&rev=557712&r1=557711&r2=557712
==============================================================================
--- maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-changelog-plugin/src/site/site.xml Thu Jul 19 11:06:42 2007
@@ -34,6 +34,7 @@
       <item name="Using Date Type" href="/examples/configuration-date-type.html"/>
       <item name="Using Range Type" href="/examples/configuration-range-type.html"/>
       <item name="Using Tag Type" href="/examples/configuration-tag-type.html"/>
+      <item name="Using Perforce" href="/examples/using-perforce.html"/>
     </menu>
   </body>
 </project>