incubator-isis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From danhayw...@apache.org
Subject svn commit: r1133677 - in /incubator/isis/trunk/viewer/bdd/src: docbkx/guide/isis-bdd-integration.xml site/apt/index.apt
Date Thu, 09 Jun 2011 06:41:49 GMT
Author: danhaywood
Date: Thu Jun  9 06:41:49 2011
New Revision: 1133677

URL: http://svn.apache.org/viewvc?rev=1133677&view=rev
Log:
added note to BDD viewer's documentation regarding XOM license dependency and our workaround

Modified:
    incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml
    incubator/isis/trunk/viewer/bdd/src/site/apt/index.apt

Modified: incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml?rev=1133677&r1=1133676&r2=1133677&view=diff
==============================================================================
--- incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml (original)
+++ incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-integration.xml Thu Jun  9 06:41:49
2011
@@ -51,7 +51,7 @@
     url="http://concordion.org">Concordion</ulink>. There is also outline
     coverage of the <ulink url="http://fitnesse.org">FitNesse</ulink>
     integration (part of <ulink
-    url="http://isis-contrib.sourceforge.net">isis-contrib</ulink>).</para>
+    url="http://code.google.com/a/apache-extras.org/p/isis-extras">isis-extras</ulink>).</para>
 
     <para>This user guide describes how to use the
     <emphasis>Concordion</emphasis> integration, along with details of the
@@ -60,7 +60,27 @@
 
     <para><emphasis>Apache Isis</emphasis> is licensed under <ulink
     url="http://www.apache.org/licenses/LICENSE-2.0.html">Apache Software
-    License v2</ulink>.</para>
+    License v2</ulink>. However, although <emphasis>Concordion</emphasis>
+    itself licensed under Apache License v2, it in turn depends upon an XML
+    library called <ulink url="http://xom.nu">XOM</ulink>, which unfortunately
+    has an <ulink url="http://www.gnu.org/licenses/lgpl-2.1.html">LGPL
+    2.1</ulink> license. Apache projects are <ulink
+    url="http://www.apache.org/legal/resolved.html#category-x">not
+    allowed</ulink> to have dependencies on <acronym>LGPL</acronym> projects.
+    </para>
+
+    <para>The workaround that we have adopted is to exclude the
+    <acronym>XOM</acronym> dependency in Isis' own
+    <filename>pom.xml</filename> files, meaning that they are compliant with
+    Apache's licensing restrictions. However, any application code that uses
+    the <emphasis>BDD Viewer</emphasis> must explicitly add its own dependency
+    to the <acronym>XOM</acronym> library. You'll find that the
+    <filename>pom.xml</filename> files generated by the quickstart archetype
+    do indeed do this.</para>
+
+    <para>However, If you are unhappy to introduce this dependency to
+    <acronym>LGPL</acronym> in your own code, then you will not be able to use
+    the <emphasis>Concordion</emphasis> integration. </para>
   </preface>
 
   <!-- main content -->
@@ -69,7 +89,9 @@
     <title>Introduction</title>
 
     <abstract>
-      <para>***</para>
+      <para>An introduction to the idea of behaviour driven development, and
+      the components that make up <emphasis>Isis</emphasis>' integration with
+      <acronym>BDD</acronym> frameworks.</para>
     </abstract>
 
     <sect1>
@@ -429,11 +451,10 @@
 
       <para>Due to licensing restrictions, the <emphasis>FitNesse</emphasis>
       integration is not part of <emphasis>Apache Isis</emphasis> proper.
-      However, it is available on the companion
-      <emphasis>isis-contrib</emphasis> site, hosted at <ulink
-      url="http://isis-contrib.sourceforge.net">sourceforge</ulink>. Check
-      that site for its release status (it is not guaranteed to be in sync
-      with <emphasis>Isis</emphasis> releases).</para>
+      However, it is available on the companion Apache Extras' <ulink
+      url="http://code.google.com/a/apache-extras.org/p/isis-extras/"><emphasis>isis-extras</emphasis></ulink>
+      site. Check that site for its release status (it is not guaranteed to be
+      in sync with <emphasis>Isis</emphasis> releases).</para>
 
       <para>An outline of the <emphasis>FitNesse</emphasis> integration
is
       provided here, if only to help compare and contrast the means by which

Modified: incubator/isis/trunk/viewer/bdd/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/viewer/bdd/src/site/apt/index.apt?rev=1133677&r1=1133676&r2=1133677&view=diff
==============================================================================
--- incubator/isis/trunk/viewer/bdd/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/viewer/bdd/src/site/apt/index.apt Thu Jun  9 06:41:49 2011
@@ -32,3 +32,21 @@ Alternatives
  However, with the junit viewer the actual test is written in {{{http://junit.org}JUnit}}
  (rather than XHTML as is the case for Concordion) and so is closer to a 
  developer test than a story test.
+
+A note on licenses
+
+  The <bdd> viewer itself is licensed under Apache License v2.  However, the
+  Concordion integration (naturally enough) depends upon {{{http://concordion.org}Concordion}},
+  which is licensed under Apache License v2 but in turn depends upon 
+  {{{http://xom.nu}Xom}}, which unfortunately has an LGPL license.  Apache projects
+  are {{{http://www.apache.org/legal/resolved.html#category-x}not allowed}} to have dependencies

+  on LGPL projects.
+  
+  There is a workaround.  Isis' pom.xml files specifically exclude the XOM dependency, meaning
+  that they are compliant with Apache's licensing restrictions.  However, any application
+  code that uses the BDD viewer must explicitly add its own dependency to the XOM library.
+  You'll find that the pom.xml files generated by the 
+  {{{../../quickstart-app.html}quickstart archetype}} do indeed do this).
+   
+  If you are unhappy to introduce this dependency to LGPL in your own code, then you will
+  not be able to use the Concordion integration.



Mime
View raw message