[slf4j-dev] svn commit: r1162 - in slf4j/trunk: . slf4j-site/src/site/pages

ceki at slf4j.org ceki at slf4j.org
Thu Oct 2 17:24:28 CEST 2008 

Author: ceki
Date: Thu Oct  2 17:24:28 2008
New Revision: 1162

Modified:
   slf4j/trunk/goVersion.sh
   slf4j/trunk/slf4j-site/src/site/pages/codes.html
   slf4j/trunk/slf4j-site/src/site/pages/compatibility.html
   slf4j/trunk/slf4j-site/src/site/pages/news.html

Log:
- adding VERSION related compatibility checks (code to follow)

Modified: slf4j/trunk/goVersion.sh
==============================================================================
--- slf4j/trunk/goVersion.sh	(original)
+++ slf4j/trunk/goVersion.sh	Thu Oct  2 17:24:28 2008
@@ -1,7 +1,6 @@
-
 VER=$1
 echo "Will use version $VER"
-
+echo "Changing pom.xml files"
 find . -name "pom.xml" |grep -v archetype-resources|xargs perl version.pl $VER 
-
-#perl version.pl $VER ./slf4j-site/src/site/site.xml
\ No newline at end of file
+echo "Changing Java files"
+find . -name "StaticLoggerBinder.java" |grep -v archetype-resources|xargs perl binderVersion.pl $VER

Modified: slf4j/trunk/slf4j-site/src/site/pages/codes.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/pages/codes.html	(original)
+++ slf4j/trunk/slf4j-site/src/site/pages/codes.html	Thu Oct  2 17:24:28 2008
@@ -160,6 +160,20 @@
     
 
 
+    <h3><a name="version_mismatch" href="#version_mismatch">slf4j-api
+    version does not match that of the binding</a></h3>
+
+    <p>Mixing mixing different versions of slf4j artifacts can cause
+    problems. For example, if you are using slf4j-api-1.5.4.jar, then
+    you should also use slf4j-simple-1.5.4.jar, using
+    slf4j-simple-1.4.2.jar will not work. 
+    </p>
+
+    <p>In general, you should take sure that the slf4j-api version
+    matches that of the slf4j binding.
+    </p>
+
+
 </div>
 </body>
 </html>

Modified: slf4j/trunk/slf4j-site/src/site/pages/compatibility.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/pages/compatibility.html	(original)
+++ slf4j/trunk/slf4j-site/src/site/pages/compatibility.html	Thu Oct  2 17:24:28 2008
@@ -30,12 +30,63 @@
   that will be covered in most detail.
   </p>
 
+  <p>Please note that in many cases incompatibility problems are
+  caused by mixing different versions of slf4j artifacts. For example,
+  if you are using slf4j-api-1.5.4.jar you should also use
+  slf4j-simple-1.5.4.jar, using slf4j-simple-1.4.2.jar will not
+  work. The same goes for all other SLF4J artifacts.
+  </p>
+
   <p>The list is computed using <a
   href="http://clirr.sourceforge.net/">clirr</a>. If you have reasons
   to suspect incompatible changes not mentioned here, please kindly
   contact the slf4j developers list.</p>
 
 
+  <h2><a href="#1_5_4" name="1_5_4">Version 1.5.4 compared to 1.5.3</a></h2>
+
+  <h3>slf4j-api module, list of breaking changes:</h3>
+  
+
+  <table class="bodyTable">
+    <tr>
+      <th>Severity</th>
+      <th>Description</th>
+      <th>Class</th>
+      <th>Method / Field</th>
+    </tr>
+    <tr>
+      <td>Error</td>
+      <td>Method 'hasReferences()' has been added to an interface</td>
+      <td>org.slf4j.Marker</td>
+      <td>public boolean hasReferences()</td>
+    </tr>
+    <tr class="alt">
+      <td>Info</td>
+      <td>Method 'hasChildren()' was deprecated</td>
+      <td>org.slf4j.Marker</td>
+      <td>public boolean hasChildren()</td>
+    </tr>
+
+  </table>
+
+  <p>&nbsp;</p>
+
+  <p>The <code>hasChildren()</code> and other documentation in the
+  Marker interface was misleading users to think in terms of parent
+  child relationship for markers. However, as <a
+  href="http://bugzilla.slf4j.org/show_bug.cgi?id=100">bug 100</a>
+  illustrates, associating markers as parents and children is not very
+  helpful. It is much better to think of markers in terms of abstract
+  graphs. As such, we now say that a marker contains (zero or more)
+  <code>references</code> to other markers.
+  </p>
+
+  <p>This breaking change is justified because it corrects a
+  conceptual error in the design. Previously, it was all too easy for
+  developers to get confused and incorrectly link markers
+  together.</p>
+
   <h2><a href="#1_5_3" name="1_5_3">Version 1.5.3 compared to 1.5.2</a></h2>
 
   <h3>slf4j-api module, list of breaking changes:</h3>

Modified: slf4j/trunk/slf4j-site/src/site/pages/news.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/pages/news.html	(original)
+++ slf4j/trunk/slf4j-site/src/site/pages/news.html	Thu Oct  2 17:24:28 2008
@@ -27,10 +27,33 @@
 
   <hr noshade="noshade" size="1"/>
 
+  <h3>September xxth, 2008 - Release of SLF4J 1.5.4</h3>
+
+  <p>See also the <a href="compatibility.html#1_5_3">compatibility
+  report for this version</a>.
+  </p>
+
+  <p>Improvements to documentations as well as fix for <a
+  href="http://bugzilla.slf4j.org/show_bug.cgi?id=102">packaging
+  problems</a> related to <em>slf4j-ext</em> module.
+  </p>
+  
+  <p>We now say that markers contain <em>references</em> to other
+  markers. We no longer talk about child markers. The javadocs of the
+  Marker interface have been updated to reflect this change. Moreover,
+  the <code>hasChildren()</code> method in the Marker interface has
+  been deprecated and a new method called <code>hasReferences()</code>
+  was added.
+  </p>
+
+
+  <hr noshade="noshade" size="1"/>
+
   <h3>September 12th, 2008 - Release of SLF4J 1.5.3</h3>
 
-  See also the <a href="compatibility.html#1_5_3">compatibility report
-  for this version</a>.
+  <p>See also the <a href="compatibility.html#1_5_3">compatibility
+  report for this version</a>.
+  </p>
 
   <p>Added a new module called slf4j-ext for slf4j-extensions. See <a
   href="extensions.html">its documentation</a> for further

More information about the slf4j-dev mailing list