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 2011/06/12 12:22:58 UTC
svn commit: r1134902 - in /incubator/isis/trunk: ./
quickstart-archetype/src/main/appended-resources/
quickstart-archetype/src/test/ site-skin/src/main/appended-resources/
src/docbkx/guide/ src/main/appended-resources/ src/site/resources/icons/
Author: danhaywood
Date: Sun Jun 12 10:22:58 2011
New Revision: 1134902
URL: http://svn.apache.org/viewvc?rev=1134902&view=rev
Log:
tidy up from running rat tool again
Removed:
incubator/isis/trunk/quickstart-archetype/src/test/
Modified:
incubator/isis/trunk/modules
incubator/isis/trunk/pom.xml
incubator/isis/trunk/quickstart-archetype/src/main/appended-resources/supplemental-models.xml
incubator/isis/trunk/site-skin/src/main/appended-resources/supplemental-models.xml
incubator/isis/trunk/src/docbkx/guide/isis-contributors-guide.xml
incubator/isis/trunk/src/main/appended-resources/supplemental-models.xml
incubator/isis/trunk/src/site/resources/icons/haywood.html
incubator/isis/trunk/src/site/resources/icons/nogl.html
incubator/isis/trunk/src/site/resources/icons/tango.html
incubator/isis/trunk/updateiconlibrary.groovy
Modified: incubator/isis/trunk/modules
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/modules?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/modules (original)
+++ incubator/isis/trunk/modules Sun Jun 12 10:22:58 2011
@@ -1,3 +1,20 @@
+# 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.
+#
./:
applib/:leaf
core/commons/:leaf
Modified: incubator/isis/trunk/pom.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/pom.xml?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/pom.xml (original)
+++ incubator/isis/trunk/pom.xml Sun Jun 12 10:22:58 2011
@@ -779,18 +779,22 @@ The above (auto-generated) list aggregat
or transitively) of all the modules that make up Apache Isis. You can use
mvn dependency:list or mvn dependency:tree to view dependencies by submodule.
+In addition, Isis includes a copy of JQuery core. This is licensed under
+the MIT license [1].
+
Note also that the BDD Viewer module [org.apache.isis.viewer:bdd-concordion]
-has an optional dependency on Concordion [1], which in turn depends upon
-XOM [2]. XOM is licensed under LGPL, which is a non-eligible 'category-X'
-license [3]. This transitive dependency to XOM has therefore been excluded.
+has an optional dependency on Concordion [2], which in turn depends upon
+XOM [3]. XOM is licensed under LGPL, which is a non-eligible 'category-X'
+license [4]. This transitive dependency to XOM has therefore been excluded.
To use Isis' BDD Viewer, end-users must explicitly add in the XOM dependency
in their own POMs. The application generated by the Isis quickstart
archetype includes this explicit dependency.
-[1] http://concordion.org
-[2] http://www.xom.nu/
-[3] http://www.apache.org/legal/resolved.html#category-x
+[1] http://jquery.org/license/
+[2] http://concordion.org
+[3] http://www.xom.nu/
+[4] http://www.apache.org/legal/resolved.html#category-x
</postDepListText>
</properties>
</configuration>
Modified: incubator/isis/trunk/quickstart-archetype/src/main/appended-resources/supplemental-models.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/quickstart-archetype/src/main/appended-resources/supplemental-models.xml?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/quickstart-archetype/src/main/appended-resources/supplemental-models.xml (original)
+++ incubator/isis/trunk/quickstart-archetype/src/main/appended-resources/supplemental-models.xml Sun Jun 12 10:22:58 2011
@@ -1,4 +1,14 @@
<?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. -->
<supplementalDataModels xmlns="http://maven.apache.org/supplemental-model/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/supplemental-model/1.0.0 http://maven.apache.org/xsd/supplemental-model-1.0.0.xsd">
Modified: incubator/isis/trunk/site-skin/src/main/appended-resources/supplemental-models.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/site-skin/src/main/appended-resources/supplemental-models.xml?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/site-skin/src/main/appended-resources/supplemental-models.xml (original)
+++ incubator/isis/trunk/site-skin/src/main/appended-resources/supplemental-models.xml Sun Jun 12 10:22:58 2011
@@ -1,4 +1,14 @@
<?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. -->
<supplementalDataModels xmlns="http://maven.apache.org/supplemental-model/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/supplemental-model/1.0.0 http://maven.apache.org/xsd/supplemental-model-1.0.0.xsd">
Modified: incubator/isis/trunk/src/docbkx/guide/isis-contributors-guide.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/docbkx/guide/isis-contributors-guide.xml?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/src/docbkx/guide/isis-contributors-guide.xml (original)
+++ incubator/isis/trunk/src/docbkx/guide/isis-contributors-guide.xml Sun Jun 12 10:22:58 2011
@@ -676,8 +676,6 @@
<sect1 id="sec.BuildingSiteAndDocs">
<title>Building the site and documentation</title>
- <para></para>
-
<sect2>
<title>Prerequisites</title>
@@ -775,12 +773,16 @@ do
cd $root
done</programlisting>
- <para>This takes a little longer to run, but is at least
- repeatable.</para>
-
<para>The file is run from a flat file,
<filename>modules</filename>, which is used to switch into each of
the leaf-level modules to run the patching.</para>
+
+ <para>To fully build the site, therefore just use:</para>
+
+ <programlisting>sh msdf.sh -o</programlisting>
+
+ <para>This takes a little longer to run, but is at least
+ repeatable.</para>
</sect2>
<sect2>
@@ -3536,12 +3538,11 @@ public class FooBar {
<itemizedlist>
<listitem>
- <para>builds ok (<code>mvn clean install</code>)</para>
+ <para>builds ok (<code>mvn clean install -o</code>)</para>
</listitem>
<listitem>
- <para>site builds ok (<code>mvn site-deploy -D deploy=local -D
- site=full</code>)</para>
+ <para>site builds ok (<code>sh msdf.sh -o</code>)</para>
</listitem>
<listitem>
@@ -3563,7 +3564,8 @@ public class FooBar {
<title>Code Cleanup / Formatting</title>
<para>Make sure that all source code has been cleaned up and
- formatted according to the Isis and ASF conventions:</para>
+ formatted according to the <emphasis>Apache Isis</emphasis> and
+ <acronym>ASF</acronym> conventions:</para>
<itemizedlist>
<listitem>
@@ -3602,28 +3604,12 @@ public class FooBar {
</itemizedlist>
</sect2>
- <sect2>
- <title>UNIX line file endings (for pom.xml files)</title>
-
- <para>We prefer to use UNIX line endings, at least for
- <filename>pom.xml</filename> files. However, running some of the
- utility groovy scripts in a Windows cmd shell can cause the files to
- be written out using Windows line endings.</para>
-
- <para>Therefore, on a UNIX machine (or Cygwin on Windows),
- run:</para>
-
- <programlisting>/usr/bin/find . -name pom.xml -print | xargs dos2unix</programlisting>
-
- <para>And then commit.</para>
- </sect2>
-
<sect2 id="sec.RatTool">
<title>License Notice (RAT Tool)</title>
- <para>The Apache Release Audit Tool (RAT) is designed to perform a
- number of basic checks, most signifcant being missing copyright
- header files.</para>
+ <para>The Apache Release Audit Tool (<acronym>RAT</acronym>) is
+ designed to perform a number of basic checks, most signifcant being
+ missing copyright header files.</para>
<para>In theory it can be run from Maven (<code>mvn
rat:check</code>), with the <filename>maven-rat-plugin</filename>
@@ -3635,9 +3621,10 @@ public class FooBar {
exclusions, making this method of performing a check somewhat
useless.</para>
- <para>Instead, the tool can be run from the command-line (though
- you'll need to build the binary <acronym>JAR</acronym> of the tool
- yourself).</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 Isis <acronym>SVN</acronym> repository; or you can build the
+ binary yourself).</para>
<para>First, clean up any generated artifacts:</para>
@@ -3645,13 +3632,12 @@ public class FooBar {
<para>Then, run the tool using:</para>
- <programlisting>java -jar apache-rat-0.8-SNAPSHOT.jar \
+ <programlisting>java -jar ../apache-rat-0.8-SNAPSHOT.jar \
-d . --exclude \
resources.txt site.vm \
*.project *.classpath *.launch *.importorder \
*.java.hsp \
*.ucd *.ucls \
- *-LICENSE.txt \
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 \
@@ -3687,11 +3673,6 @@ public class FooBar {
</listitem>
<listitem>
- <para><filename>-LICENSE.txt</filename> are required license
- files for certain third party dependencies</para>
- </listitem>
-
- <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>
@@ -3723,6 +3704,7 @@ public class FooBar {
<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" \
@@ -3751,9 +3733,10 @@ public class FooBar {
<para>Although <emphasis>Apache Isis</emphasis> has no dependencies
which have incompatible licenses, the <acronym>POM</acronym>s for
these dependencies (in the Maven central repo) do not necessarily
- contain the required license information. This results in the
- <filename>META-INF/DEPENDENCIES</filename> file and generated Maven
- site listing dependencies as being "unknown".</para>
+ contain the required license information. When the release process
+ is run this results in the generated
+ <filename>DEPENDENCIES</filename> file and generated Maven site
+ listing dependencies as having "unknown" licenses.</para>
<para>Fortunately, Maven allows the missing information to be
provided by configuring the
@@ -3764,8 +3747,7 @@ public class FooBar {
<para>To capture the missing license information, use:</para>
- <programlisting>mvn license:download-licenses
-groovy checkmissinglicenses.groovy</programlisting>
+ <programlisting>mvn license:download-licenses</programlisting>
<para>This Maven plugin creates a <filename>license.xml</filename>
file in the <filename>target/generated</filename>-resources/
@@ -4202,21 +4184,22 @@ svn: No such revision 1126567</programli
<itemizedlist>
<listitem>
<para>unzip the source-release <acronym>ZIP</acronym> and check
- it compiles</para>
+ it builds</para>
<para>The <acronym>ZIP</acronym> file resides in
<filename>isis-0.x.x[-RCn]-incubating-incubating-source-release.zip</filename>
in <filename>target</filename> directory of the parent
<package>[oai:isis]</package> module. Unzip in a new directory,
- and build using <code>mvn clean install</code> (and <code>mvn
- site-deploy -D deploy=local</code> if you have the time).</para>
+ and build (see <xref
+ linkend="chp.BuildingIsisFromSource" />).</para>
</listitem>
<listitem>
<para>Inspect the <filename>DEPENDENCIES</filename> file.</para>
- <para>This should be in the root of the extracted ZIP. In
- particular, check that there are no <ulink
+ <para>This should be in the root of the extracted
+ <acronym>ZIP</acronym>. In particular, check that there are no
+ <ulink
url="www.apache.org/legal/resolved.html#category-x">category-x</ulink>
dependencies.</para>
</listitem>
@@ -4776,17 +4759,38 @@ cp ~/public_html/isis-x.x.x-incubating-s
repository, from there they will be automatically moved to the Maven
repository.</para>
</sect2>
+
+ <sect2>
+ <title>Manually Deploy the Release Website</title>
+
+ <para>The mechanics of deploying the release site is the same as
+ deploying a snapshot site, however there is the complication of
+ deploying from the relevant
+ <filename>tags/x.x.x-incubating</filename> tag (rather than
+ <filename>trunk</filename>) as well as ensuring that the released
+ binaries are correctly referenced on the downloads page.</para>
+ </sect2>
</sect1>
<sect1 id="sec.ManuallyDeployReleaseSite">
- <title>Manually Deploy the Release Website</title>
+ <title>Merge changes from branch back into trunk</title>
- <para>The mechanics of deploying the release site is the same as
- deploying a snapshot site, however there is the complication of
- deploying from the relevant <filename>tags/x.x.x-incubating</filename>
- tag (rather than <filename>trunk</filename>) as well as ensuring that
- the released binaries are correctly referenced on the downloads
- page.</para>
+ <para>Because we release from a branch, the changes made in the branch
+ (changes to <filename>pom.xml</filename> made automatically by the
+ release-plugin, or any manual edits) should be merged back from the
+ release branch back into trunk.</para>
+
+ <para>You can if you wish use <acronym>SVN</acronym>'s
+ <code>merge</code> command for this (using the "reintegrate" flag).
+ However, you may well find it easy just to use a directory comparison
+ tool such as <emphasis>Beyond Compare</emphasis> or
+ <emphasis>WinMerge</emphasis>.</para>
+
+ <para>Finally, remember that the version in the
+ <filename>pom.xml</filename> for any modules that are not part of the
+ release (in particular, the <filename>examples</filename> and
+ <filename>domain-libs</filename> modules) should be manually updated
+ also.</para>
</sect1>
</chapter>
Modified: incubator/isis/trunk/src/main/appended-resources/supplemental-models.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/main/appended-resources/supplemental-models.xml?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/src/main/appended-resources/supplemental-models.xml (original)
+++ incubator/isis/trunk/src/main/appended-resources/supplemental-models.xml Sun Jun 12 10:22:58 2011
@@ -1,4 +1,14 @@
<?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. -->
<supplementalDataModels xmlns="http://maven.apache.org/supplemental-model/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/supplemental-model/1.0.0 http://maven.apache.org/xsd/supplemental-model-1.0.0.xsd">
Modified: incubator/isis/trunk/src/site/resources/icons/haywood.html
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/resources/icons/haywood.html?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/src/site/resources/icons/haywood.html (original)
+++ incubator/isis/trunk/src/site/resources/icons/haywood.html Sun Jun 12 10:22:58 2011
@@ -1,3 +1,13 @@
+<!-- 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. -->
<html><head><title>haywood</title></head><body>
<!-- START SNIPPET: icon-table -->
<table>
Modified: incubator/isis/trunk/src/site/resources/icons/nogl.html
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/resources/icons/nogl.html?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/src/site/resources/icons/nogl.html (original)
+++ incubator/isis/trunk/src/site/resources/icons/nogl.html Sun Jun 12 10:22:58 2011
@@ -1,3 +1,13 @@
+<!-- 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. -->
<html><head><title>nogl</title></head><body>
<!-- START SNIPPET: icon-table -->
<table>
Modified: incubator/isis/trunk/src/site/resources/icons/tango.html
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/resources/icons/tango.html?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/src/site/resources/icons/tango.html (original)
+++ incubator/isis/trunk/src/site/resources/icons/tango.html Sun Jun 12 10:22:58 2011
@@ -1,3 +1,13 @@
+<!-- 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. -->
<html><head><title>tango</title></head><body>
<!-- START SNIPPET: icon-table -->
<p>Actions</p><table>
Modified: incubator/isis/trunk/updateiconlibrary.groovy
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/updateiconlibrary.groovy?rev=1134902&r1=1134901&r2=1134902&view=diff
==============================================================================
--- incubator/isis/trunk/updateiconlibrary.groovy (original)
+++ incubator/isis/trunk/updateiconlibrary.groovy Sun Jun 12 10:22:58 2011
@@ -104,11 +104,19 @@ iconsByCategoryByPage.each { pageName, i
def numCols = colsPerRow[pageName]
def buf = new StringBuilder()
- buf.append("<html><head><title>${pageName}</title></head><body>\n")
- buf.append("<!-- START SNIPPET: icon-table -->\n")
-
- //def numIcons = 0
- //buf.append("<table>\n")
+ buf.append("""<!-- 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. -->
+<html><head><title>${pageName}</title></head><body>
+<!-- START SNIPPET: icon-table -->
+""")
iconsByCategory.each { categoryName, iconsByName ->
@@ -147,19 +155,12 @@ iconsByCategoryByPage.each { pageName, i
buf.append("<td/>")
}
buf.append("</tr>\n")
- //numIcons=0
}
- //buf.append("<tr>\n")
- //numCols.each {
- //buf.append("<td/>")
- //}
- //buf.append("</tr>\n")
buf.append("</table>\n")
}
- //buf.append("</table>\n")
- buf.append("<!-- END SNIPPET: icon-table -->\n")
- buf.append("</body></html>\n")
+ buf.append("""<!-- END SNIPPET: icon-table -->
+</body></html>\n""")
def pageFileText = buf.toString()
pageFile.text = pageFileText