You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2012/02/01 02:06:02 UTC

svn commit: r1238893 - in /incubator/isis/trunk/framework: ./ core/testsupport/src/test/java/org/apache/isis/core/testsupport/jmock/ progmodels/src/docbkx/guide/ quickstart-archetype/ quickstart-archetype/src/test/ runtimes/dflt/monitoring/src/main/jav...

Author: danhaywood
Date: Wed Feb  1 01:06:02 2012
New Revision: 1238893

URL: http://svn.apache.org/viewvc?rev=1238893&view=rev
Log:
ISIS-165: fixing rat errors and updating contributors guide

Removed:
    incubator/isis/trunk/framework/quickstart-archetype/src/test/
    incubator/isis/trunk/framework/runtimes/dflt/monitoring/src/main/java/META-INF/
    incubator/isis/trunk/framework/viewer/json/json-viewer/src/main/webapp/META-INF/
Modified:
    incubator/isis/trunk/framework/core/testsupport/src/test/java/org/apache/isis/core/testsupport/jmock/JUnit4RuleMockery2Test.java
    incubator/isis/trunk/framework/pom.xml
    incubator/isis/trunk/framework/progmodels/src/docbkx/guide/isis-progmodels.xml
    incubator/isis/trunk/framework/quickstart-archetype/   (props changed)
    incubator/isis/trunk/framework/site-skin/src/main/resources/META-INF/maven/site.vm
    incubator/isis/trunk/framework/src/docbkx/guide/isis-contributors-guide.xml
    incubator/isis/trunk/framework/src/site/resources/codequality/checkstyle.xml
    incubator/isis/trunk/framework/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml
    incubator/isis/trunk/framework/viewer/json/src/docbkx/guide/isis-json-viewer.xml

Modified: incubator/isis/trunk/framework/core/testsupport/src/test/java/org/apache/isis/core/testsupport/jmock/JUnit4RuleMockery2Test.java
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/framework/core/testsupport/src/test/java/org/apache/isis/core/testsupport/jmock/JUnit4RuleMockery2Test.java?rev=1238893&r1=1238892&r2=1238893&view=diff
==============================================================================
--- incubator/isis/trunk/framework/core/testsupport/src/test/java/org/apache/isis/core/testsupport/jmock/JUnit4RuleMockery2Test.java (original)
+++ incubator/isis/trunk/framework/core/testsupport/src/test/java/org/apache/isis/core/testsupport/jmock/JUnit4RuleMockery2Test.java Wed Feb  1 01:06:02 2012
@@ -1,3 +1,21 @@
+/*
+ *  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.
+ */
 package org.apache.isis.core.testsupport.jmock;
 
 import org.jmock.Expectations;

Modified: incubator/isis/trunk/framework/pom.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/framework/pom.xml?rev=1238893&r1=1238892&r2=1238893&view=diff
==============================================================================
--- incubator/isis/trunk/framework/pom.xml (original)
+++ incubator/isis/trunk/framework/pom.xml Wed Feb  1 01:06:02 2012
@@ -1,15 +1,21 @@
 <?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. 
+    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 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/xsd/maven-4.0.0.xsd">
@@ -849,44 +855,95 @@ archetype includes this explicit depende
                 <artifactId>apache-rat-plugin</artifactId>
                 <configuration>
                     <addDefaultLicenseMatchers>true</addDefaultLicenseMatchers>
-                    <excludeSubProjects>false</excludeSubProjects>
+                    <excludeSubProjects>true</excludeSubProjects>
                     <numUnapprovedLicenses>0</numUnapprovedLicenses>
                     <excludes>
+                        <exclude>**/*.project</exclude>
+                        <exclude>**/.classpath</exclude>
+                        <exclude>**/.settings/**</exclude>
+                        <exclude>**/*.launch</exclude>
+                        <exclude>src/site/resources/ide/eclipse/**</exclude>
+
                         <exclude>**/*.java.hsp</exclude>
-                        <exclude>**/*.svg</exclude>
                         <exclude>**/*.ucd</exclude>
+                        <exclude>**/*.ucls</exclude>
+
+                        <exclude>**/*.svg</exclude>
+                        <exclude>**/*.pdn</exclude>
+                        
+                        <exclude>**/*.json</exclude>
+                        <exclude>**/rat.txt</exclude>
+                        <exclude>**/isis.log</exclude>
+
+                        <exclude>**/fixture-data</exclude>
+                        <exclude>**/test.data</exclude>
+                        <exclude>**/xml/**/*.xml</exclude>
+                        <exclude>tmp/tests/*.xml</exclude>
+
+                        <exclude>**/hsql-db/**/*.script</exclude>
+                        <exclude>**/hsql-db/**/*.properties</exclude>
+                        <exclude>**/hsql-db/**/*.log</exclude>
+                        
+                        <exclude>**/ldap-conf/**</exclude>
+
+                        <exclude>**/src/main/resources/resources.txt</exclude>
+                        <exclude>**/src/main/appended-resources/supplemental-models.xml</exclude>
+
+                        <exclude>**/*.min.js</exclude>
                     </excludes>
                     <licenses>
-		              <license implementation="org.apache.rat.analysis.license.SimplePatternBasedLicense">
-		                <licenseFamilyCategory>DOCBK</licenseFamilyCategory>
-		                <licenseFamilyName>DocBook 4.5</licenseFamilyName>
-		                <notes></notes>
-		                <patterns>
-		                  <pattern>Permission to copy in any form is granted for use</pattern>
+                      <license implementation="org.apache.rat.analysis.license.SimplePatternBasedLicense">
+                        <licenseFamilyCategory>AL2  </licenseFamilyCategory>
+                        <licenseFamilyName>Apache License 2.0</licenseFamilyName>
+                        <notes></notes>
+                        <patterns>
+                          <pattern>Licensed to the Apache Software Foundation (ASF) under one</pattern>
+                        </patterns>
+                      </license>
+                      <license implementation="org.apache.rat.analysis.license.SimplePatternBasedLicense">
+                        <licenseFamilyCategory>JQRY</licenseFamilyCategory>
+                        <licenseFamilyName>MIT  </licenseFamilyName>
+                        <notes></notes>
+                        <patterns>
+                          <pattern>Dual licensed under the MIT or GPL Version 2 licenses.</pattern>
+                        </patterns>
+                      </license>
+                      <license implementation="org.apache.rat.analysis.license.SimplePatternBasedLicense">
+                        <licenseFamilyCategory>DOCBK</licenseFamilyCategory>
+                        <licenseFamilyName>DocBook 4.5</licenseFamilyName>
+                        <notes></notes>
+                        <patterns>
+                          <pattern>Permission to copy in any form is granted for use</pattern>
                           <pattern>Permission to use, copy, modify and distribute the DocBook DTD</pattern>
                           <pattern>is hereby granted in perpetuity, provided that the above copyright</pattern>
                           <pattern>This is the catalog data file for DocBook XML V4.5. It is provided as</pattern>
                           <pattern>XML Catalog data for DocBook XML V4.5</pattern>
                           <pattern>DocBook additional general entities V4.5</pattern>
                           <pattern>XML EXCHANGE TABLE MODEL DECLARATION MODULE</pattern>
-		                </patterns>
-		              </license>
+                        </patterns>
+                      </license>
                       <license implementation="org.apache.rat.analysis.license.SimplePatternBasedLicense">
-                        <licenseFamilyCategory>AL2  </licenseFamilyCategory>
-                        <licenseFamilyName>Apache License 2.0</licenseFamilyName>
+                        <licenseFamilyCategory>W3C  </licenseFamilyCategory>
+                        <licenseFamilyName>XHTML</licenseFamilyName>
                         <notes></notes>
                         <patterns>
-                          <pattern>Licensed to the Apache Software Foundation (ASF) under one</pattern>
+                          <pattern>Copyright (c) 1998-2002 W3C (MIT, INRIA, Keio),</pattern>
                         </patterns>
                       </license>
 		            </licenses>
 		            <licenseFamilies>
-		              <licenseFamily implementation="org.apache.rat.license.SimpleLicenseFamily">
-		                <familyName>DocBook 4.5</familyName>
-		              </licenseFamily>
                       <licenseFamily implementation="org.apache.rat.license.SimpleLicenseFamily">
                         <familyName>Apache License 2.0</familyName>
                       </licenseFamily>
+                      <licenseFamily implementation="org.apache.rat.license.SimpleLicenseFamily">
+                        <familyName>MIT</familyName>
+                      </licenseFamily>
+                      <licenseFamily implementation="org.apache.rat.license.SimpleLicenseFamily">
+                        <familyName>DocBook 4.5</familyName>
+                      </licenseFamily>
+                      <licenseFamily implementation="org.apache.rat.license.SimpleLicenseFamily">
+                        <familyName>XHTML</familyName>
+                      </licenseFamily>
 		            </licenseFamilies>
                 </configuration>
             </plugin>

Modified: incubator/isis/trunk/framework/progmodels/src/docbkx/guide/isis-progmodels.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/framework/progmodels/src/docbkx/guide/isis-progmodels.xml?rev=1238893&r1=1238892&r2=1238893&view=diff
==============================================================================
--- incubator/isis/trunk/framework/progmodels/src/docbkx/guide/isis-progmodels.xml (original)
+++ incubator/isis/trunk/framework/progmodels/src/docbkx/guide/isis-progmodels.xml Wed Feb  1 01:06:02 2012
@@ -1,4 +1,22 @@
 <?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.
+-->
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "file:./src/docbkx/dtd-4.5/docbookx.dtd">
 <book>

Propchange: incubator/isis/trunk/framework/quickstart-archetype/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Wed Feb  1 01:06:02 2012
@@ -0,0 +1,2 @@
+.settings
+.project

Modified: incubator/isis/trunk/framework/site-skin/src/main/resources/META-INF/maven/site.vm
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/framework/site-skin/src/main/resources/META-INF/maven/site.vm?rev=1238893&r1=1238892&r2=1238893&view=diff
==============================================================================
--- incubator/isis/trunk/framework/site-skin/src/main/resources/META-INF/maven/site.vm (original)
+++ incubator/isis/trunk/framework/site-skin/src/main/resources/META-INF/maven/site.vm Wed Feb  1 01:06:02 2012
@@ -1,4 +1,22 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+    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. 
+-->
 <!-- Not Generated by Apache Maven Doxia at $dateFormat.format( $currentDate ) -->
 <!-- Relative path: $relativePath -->
 #macro ( link $href $name $target $img $position $alt $border $width $height )

Modified: incubator/isis/trunk/framework/src/docbkx/guide/isis-contributors-guide.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/framework/src/docbkx/guide/isis-contributors-guide.xml?rev=1238893&r1=1238892&r2=1238893&view=diff
==============================================================================
--- incubator/isis/trunk/framework/src/docbkx/guide/isis-contributors-guide.xml (original)
+++ incubator/isis/trunk/framework/src/docbkx/guide/isis-contributors-guide.xml Wed Feb  1 01:06:02 2012
@@ -3798,124 +3798,259 @@ public class FooBar {
           designed to perform a number of basic checks, most signifcant being
           missing copyright header files.</para>
 
-          <para>In theory the RAT tool can be run from Maven (<code>mvn
-          rat:check</code>), with the <filename>maven-rat-plugin</filename>
-          being inherited from the Apache parent <acronym>POM</acronym>.
-          However, although the plugin is configured in the
-          <emphasis>Isis</emphasis> parent <acronym>POM</acronym> to exclude
-          certain files (eg <filename>.java.hsp</filename> project files for
-          Structure101), unfortunately the plugin seems to ignore any
-          configured exclusions, making this method of performing a check
-          somewhat useless.</para>
-
-          <para>Instead, the tool can be run from the command-line (you'll
-          find a snapshot copy of the <acronym>JAR</acronym> is in the root of
-          the <emphasis>Isis </emphasis><acronym>SVN</acronym> repository; or
-          you can build the binary yourself).</para>
+          <para>The <emphasis>Isis</emphasis> parent <acronym>POM</acronym>
+          specifies the RAT Maven plugin, with the following custom
+          configuration:</para>
 
-          <para>First, clean up any generated artifacts:</para>
+          <table>
+            <title>RAT plugin Configuration Exclusions</title>
 
-          <programlisting>mvn clean -P integration-tests</programlisting>
+            <tgroup cols="3">
+              <thead>
+                <row>
+                  <entry align="center">Subtype</entry>
 
-          <para>Then, run the tool using:</para>
+                  <entry align="center">File path(s)</entry>
 
-          <programlisting>java -jar ../apache-rat-0.8-SNAPSHOT.jar \
-  -d . --exclude \
-  resources.txt site.vm \
-  *.project *.classpath *.launch *.importorder \
-  *.odg \
-  *.java.hsp \
-  *.ucd *.ucls *.euml2 *.umlproject \
-  fop-cust.xsl html-cust.xsl *.ent *.dtd *.pdn catalog.xml \
-  *.mod usage.txt screen.css docbook.cat \
-  org.apache.isis.viewer.wicket.ui.ComponentFactory \
-  *.json fixture-data test.data example.ldif slapd.conf \
-  .plxarc MANIFEST.MF \
-  .log \
-  &gt;/tmp/rat.txt</programlisting>
+                  <entry align="center">Description</entry>
+                </row>
+              </thead>
 
-          <para>where:</para>
+              <tbody>
+                <row>
+                  <entry>IDE-specific</entry>
 
-          <itemizedlist>
-            <listitem>
-              <para><filename>resources.txt, site.vm</filename> are resources
-              to do with site generation</para>
-            </listitem>
+                  <entry>**/.project, **/.classpath, **/.settings/**</entry>
 
-            <listitem>
-              <para><filename>.project, .classpath, .launch</filename> and
-              <filename>.importorder</filename> are Eclipse
-              <acronym>IDE</acronym> project files</para>
-            </listitem>
+                  <entry>Eclipse project files</entry>
+                </row>
 
-            <listitem>
-              <para><filename>.json</filename> are test JSON files (JSON does
-              not support comments)</para>
-            </listitem>
+                <row>
+                  <entry></entry>
 
-            <listitem>
-              <para><filename>.odg</filename> are OpenOffice diagram
-              files</para>
-            </listitem>
+                  <entry>**/*.launch</entry>
 
-            <listitem>
-              <para><filename>.java.hsp</filename> are the <ulink
-              url="http://www.headwaysoftware.com/products/?code=Structure101">Structure101</ulink>
-              project files</para>
-            </listitem>
+                  <entry>Eclipse launch configuration file</entry>
+                </row>
 
-            <listitem>
-              <para><filename>.ucd</filename> and <filename>.ucls</filename>
-              are <ulink url="http://www.soyatec.com/euml2/">Soyatec
-              (<acronym>UML</acronym> plugin)</ulink> project files,
-              <filename>.euml2</filename> and <filename>.umlproject</filename>
-              are similar</para>
-            </listitem>
+                <row>
+                  <entry></entry>
 
-            <listitem>
-              <para><filename>fop-cust.xsl html-cust.xsl *.ent *.dtd *.pdn
-              catalog.xml *.mod usage.txt screen.css docbook.cat</filename>
-              are files related to DocBook generation</para>
-            </listitem>
+                  <entry>src/site/resources/ide/eclipse/**</entry>
 
-            <listitem>
-              <para><filename>org.apache.isis.viewer.wicket.ui.ComponentFactory</filename>
-              is a manifest file required for dynamic classloading</para>
-            </listitem>
+                  <entry>Various Eclipse config files for contributors'
+                  use</entry>
+                </row>
 
-            <listitem>
-              <para><filename>*.json, fixture-data, test.data, example.ldif,
-              slapd.conf</filename> are test resource files</para>
-            </listitem>
+                <row>
+                  <entry></entry>
 
-            <listitem>
-              <para><filename>.plxarc</filename> and
-              <filename>MANIFEST.MF</filename> are artifacts generated by
-              various Maven goals</para>
-            </listitem>
+                  <entry>**/*java.hsp</entry>
 
-            <listitem>
-              <para><filename>.log</filename> are any generated log
-              files</para>
-            </listitem>
-          </itemizedlist>
+                  <entry><ulink
+                  url="http://www.headwaysoftware.com/products/?code=Structure101">Structure101</ulink>
+                  project file</entry>
+                </row>
 
-          <para>Then, review any missing license notes using:</para>
+                <row>
+                  <entry></entry>
 
-          <programlisting>cat /tmp/rat.txt \
-   | grep '^ !???' \
-   | grep -v "jquery.*.js" \
-   | grep -v "tests-common/.*\.xml" \
-   | grep -v "tests-common/.*/tests\..*" \
-   | grep -v "tests-common/.*\.xml" \
-   | grep -v "tests-common/.*\.script" \
-   | grep -v "tests/.*\.xml" \
-   | grep -v "isis.log" \
-   | grep -v "target" \
-   | grep -v "test/.*\.json" \
-   | grep -v "hsql-db"</programlisting>
+                  <entry>**/*.ucd, **/*.ucls</entry>
 
-          <para>where:</para>
+                  <entry><ulink url="http://www.soyatec.com/euml2/">Soyatec
+                  (<acronym>UML</acronym> plugin)</ulink> project
+                  files</entry>
+                </row>
+
+                <row>
+                  <entry>Image formats</entry>
+
+                  <entry>**/*.svg</entry>
+
+                  <entry>Scalable Vector Graphics</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>**/*.pdn</entry>
+
+                  <entry>Paint.NET format</entry>
+                </row>
+
+                <row>
+                  <entry>Data files</entry>
+
+                  <entry>**/*.json</entry>
+
+                  <entry>JSON (test) data</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>**/isis.log</entry>
+
+                  <entry>Isis' log file (byproduct of tests)</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>**/rat.txt</entry>
+
+                  <entry>RAT's own audit file</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>**/fixture-data</entry>
+
+                  <entry>SQL Object Store fixture data</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>**/test.data</entry>
+
+                  <entry>SQL Object Store fixture data</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>**/xml/**/*.xml</entry>
+
+                  <entry>XML Object Store fixture data</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>tmp/tests/*.xml</entry>
+
+                  <entry>XML Object Store fixture data</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>**/ldap-conf/**</entry>
+
+                  <entry>LDAP Security fixture data</entry>
+                </row>
+
+                <row>
+                  <entry>Archetype Support</entry>
+
+                  <entry>**/src/main/resources/resources.txt</entry>
+
+                  <entry>Resource file</entry>
+                </row>
+
+                <row>
+                  <entry></entry>
+
+                  <entry>**/src/main/appended-resources/<para>
+                  supplemental-models.xml</para></entry>
+
+                  <entry>(Empty) supplemental models</entry>
+                </row>
+
+                <row>
+                  <entry>Program formats</entry>
+
+                  <entry>**/*.min.js</entry>
+
+                  <entry>Minified Javascript (note that the non-Minified
+                  Javascript equivalents is checked for its license)</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </table>
+
+          <para>In addition, a number of licenses are configured:</para>
+
+          <table>
+            <title>RAT plugin Configuration Additional Licenses</title>
+
+            <tgroup cols="2">
+              <thead>
+                <row>
+                  <entry align="center">License</entry>
+
+                  <entry align="center">Description</entry>
+                </row>
+              </thead>
+
+              <tbody>
+                <row>
+                  <entry>Apache 2.0</entry>
+
+                  <entry>The RAT tool searches for an older version of the
+                  Apache license header. This additional license reconfigures
+                  RAT to use the current form of words </entry>
+                </row>
+
+                <row>
+                  <entry>MIT</entry>
+
+                  <entry>JQuery (bundled with Isis) is dual licensed under
+                  MIT</entry>
+                </row>
+
+                <row>
+                  <entry>DocBook</entry>
+
+                  <entry>Like many other Apache projects, Isis generates its
+                  documentation in DocBook form. In order to speed up
+                  generation, Isis has a local copy of the DocBook DTDs,
+                  Entities etc. Key phrases from these files are configured so
+                  that RAT identifies these files as valid to use.</entry>
+                </row>
+
+                <row>
+                  <entry>XHTML</entry>
+
+                  <entry>Isis also has a dependency on the XHTML-strict DTD.
+                  </entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </table>
+
+          <para>To run the RAT tool, first clean up any generated
+          artifacts:</para>
+
+          <programlisting>mvn clean -P integration-tests</programlisting>
+
+          <para>Then, run the tool using:</para>
+
+          <programlisting>mvn org.apache.rat:apache-rat-plugin:check</programlisting>
+
+          <para><note>
+              <para>Do <emphasis>not</emphasis> use mvn rat:check; depending
+              on your local Maven configuratoin this may bring down the
+              obsolete mvn-rat-plugin from Codehaus repo.</para>
+            </note>All being well the command should succeed:</para>
+
+          <programlisting>...
+[INFO] JUnit Viewer ...................................... SUCCESS [0.162s]
+[INFO] JUnit Tests for TCK ............................... SUCCESS [0.039s]
+[INFO] quickstart-archetype .............................. SUCCESS [0.382s]
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time: 30.796s
+[INFO] Finished at: Wed Feb 01 00:36:25 GMT 2012
+[INFO] Final Memory: 41M/967M
+[INFO] ------------------------------------------------------------------------p</programlisting>
+
+          <para>If it does not, then review the <filename>rat.txt</filename>
+          file in the failing module's <filename>target</filename> directory.
+          Missing license notes are indicated using the key:</para>
 
           <itemizedlist>
             <listitem>
@@ -4378,9 +4513,9 @@ What is the release version for "Apache 
             </listitem>
           </itemizedlist>
 
-          <para>If you are running outside the US, then the <code>mvn release:prepare</code>
-          command almost always fails at the last step, with a message
-          like:</para>
+          <para>If you are running outside the US, then the <code>mvn
+          release:prepare</code> command almost always fails at the last step,
+          with a message like:</para>
 
           <programlisting>[INFO] Checking in modified POMs...
 [INFO] Executing: cmd.exe /X /C "svn --non-interactive 
@@ -4427,10 +4562,12 @@ svn: No such revision 1126567</programli
           </itemizedlist>
 
           <note>
-           <para>The configuration for the maven-release-plugin in the parent <code>pom.xml</code> now uses 
-           the waitBeforeTagging setting to wait a while; hopefully this error will be less commonplace in the future.</para>
+            <para>The configuration for the maven-release-plugin in the parent
+            <code>pom.xml</code> now uses the waitBeforeTagging setting to
+            wait a while; hopefully this error will be less commonplace in the
+            future.</para>
           </note>
-         
+
           <para>On the other hand, if things go wrong before the tagging, then
           <code>mvn release:clean</code> will do most of the cleaning up in
           the event of failures.</para>

Modified: incubator/isis/trunk/framework/src/site/resources/codequality/checkstyle.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/framework/src/site/resources/codequality/checkstyle.xml?rev=1238893&r1=1238892&r2=1238893&view=diff
==============================================================================
--- incubator/isis/trunk/framework/src/site/resources/codequality/checkstyle.xml (original)
+++ incubator/isis/trunk/framework/src/site/resources/codequality/checkstyle.xml Wed Feb  1 01:06:02 2012
@@ -1,22 +1,22 @@
 <?xml version="1.0"?>
-<!-- 
-/*
- * Copyright 2001-2004 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.
- */
- -->
-
+<!--
+    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. 
+-->
 <!DOCTYPE module PUBLIC
     "-//Puppy Crawl//DTD Check Configuration 1.1//EN"
     "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">

Modified: incubator/isis/trunk/framework/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/framework/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml?rev=1238893&r1=1238892&r2=1238893&view=diff
==============================================================================
--- incubator/isis/trunk/framework/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml (original)
+++ incubator/isis/trunk/framework/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml Wed Feb  1 01:06:02 2012
@@ -1,4 +1,22 @@
 <?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.
+-->
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "file:./src/docbkx/dtd-4.5/docbookx.dtd">
 <book>

Modified: incubator/isis/trunk/framework/viewer/json/src/docbkx/guide/isis-json-viewer.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/framework/viewer/json/src/docbkx/guide/isis-json-viewer.xml?rev=1238893&r1=1238892&r2=1238893&view=diff
==============================================================================
--- incubator/isis/trunk/framework/viewer/json/src/docbkx/guide/isis-json-viewer.xml (original)
+++ incubator/isis/trunk/framework/viewer/json/src/docbkx/guide/isis-json-viewer.xml Wed Feb  1 01:06:02 2012
@@ -1,4 +1,22 @@
 <?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.
+-->
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "file:./src/docbkx/dtd-4.5/docbookx.dtd">
 <book>