[slf4j-dev] svn commit: r637 - slf4j/trunk/slf4j-site/src/site/xdocs
ceki at slf4j.org
ceki at slf4j.org
Mon Sep 4 21:50:40 CEST 2006
Author: ceki
Date: Mon Sep 4 21:50:39 2006
New Revision: 637
Added:
slf4j/trunk/slf4j-site/src/site/xdocs/
slf4j/trunk/slf4j-site/src/site/xdocs/bug-reporting.xml
slf4j/trunk/slf4j-site/src/site/xdocs/codes.xml
slf4j/trunk/slf4j-site/src/site/xdocs/docs.xml
slf4j/trunk/slf4j-site/src/site/xdocs/download.xml
slf4j/trunk/slf4j-site/src/site/xdocs/index.xml
slf4j/trunk/slf4j-site/src/site/xdocs/license.xml
slf4j/trunk/slf4j-site/src/site/xdocs/mailing-lists.xml
slf4j/trunk/slf4j-site/src/site/xdocs/manual.xml
slf4j/trunk/slf4j-site/src/site/xdocs/news.xml
slf4j/trunk/slf4j-site/src/site/xdocs/svn.xml
Log:
Added: slf4j/trunk/slf4j-site/src/site/xdocs/bug-reporting.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/bug-reporting.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,85 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author>Ceki Gulcu</author>
+ <author>Glenn L. Nielsen</author>
+ <author>Yoav Shapira</author>
+ <title>Bug Report Guidelines</title>
+ </properties>
+
+<body>
+
+ <h1>Before you report a bug</h1>
+
+ <p>The SLF4J community consists of those who use SLF4J and its
+ implementations, help answer questions on discussions lists,
+ contribute documentation and patches, and those who develop and
+ maintain the code for SLF4J and its implementations. Almost all
+ those who assist on a day to day basis resolving bug reports do
+ this for a wide variety of reasons, and almost all of them do this
+ on their own time.
+ </p>
+
+ <p>Many bugs reported end up not being a bug in SLF4J, but are due
+ to misconfiguration, problems caused by installed applications,
+ the operating system, etc.
+ </p>
+
+ <p>Before reporting a bug please make every effort to resolve the
+ problem yourself. <em>Just reporting a bug will not fix it. A good
+ bug report includes a detailed description of the problem and a
+ succinct test case which can reproduce the problem.</em>
+ </p>
+
+ <h3>Review the documentation</h3>
+
+ <p>Review the documentation for the version of component you are
+ using. The problem you are having may already be addressed in the
+ docs.
+ </p>
+
+ <h3>Search the mailing list archives</h3>
+
+ <p>It is very likely you are not the first to run into a problem.
+ Others may have already found a solution. Our various <a
+ href="mailing-lists.html">mailing lists</a> are likely to have
+ discussed this problem before.
+ </p>
+
+ <h3>Search Bugzilla</h3>
+
+ <p>Please search the bug database to see if the bug you are seeing
+ has already been reported. The bug may have already been fixed
+ and is available in a later version. If someone else has reported
+ the same bug, you could add supporting information to help
+ reproduce and resolve the bug.
+ </p>
+
+ <ul>
+ <li>
+ <a href="http://bugzilla.slf4j.org/query.cgi?product=SLF4J">Search for <b>SLF4J</b> bugs</a>
+ </li>
+ </ul>
+ <h2>Reporting with Bugzilla</h2>
+
+ <p>Onlly after you have exhausted the aforementioned steps, should
+ you file a formal report in bugzilla.
+ </p>
+
+ <p>Please make sure you provide as much information as
+ possible. Its very hard to fix a bug if the person looking into
+ the problem can't reproduce it.
+ </p>
+
+ <ul>
+ <li><a
+ href="http://bugzilla.slf4j.org/enter_bug.cgi?product=SLF4J">Report
+ new <b>SLF4J</b> bug</a>
+ </li>
+ </ul>
+
+
+
+</body>
+</document>
Added: slf4j/trunk/slf4j-site/src/site/xdocs/codes.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/codes.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+
+<document>
+
+ <properties>
+ <author email="not at disclosed">Ceki Gülcü</author>
+ <title>Log4j error codes</title>
+ </properties>
+
+ <body>
+
+ <center>
+ <h2>SLF4J warning or error messages and their meanings</h2>
+ <h3>Ceki Gülcü <br/>
+ created May 2006, last updated on May 2006</h3>
+ </center>
+
+
+ <message ref="release">
+
+ <title>The method
+ <code>o.a.commons.logging.impl.SLF4FLogFactory#release</code>
+ was invoked.</title>
+
+ <explanation>
+ <p>Given the structure of the commons-logging API, in
+ particular as implemented by SLF4J, the
+ <code>o.a.commons.logging.impl.SLF4FLogFactory#release()</code>
+ method should never be called. However, depending on the
+ deployment of <em>commons-logging.jar</em> files in your
+ servlet container, <code>release()</code> may be unexpectedly
+ invoked by a copy of
+ <code>org.apache.commons.logging.LogFactory</code> class
+ shipping with <em>commons-logging.jar</em>.
+ </p>
+
+ <p>This is a relatively common occurrence with recent versions
+ of Tomcat, especially if you place
+ <em>jcl104-over-slf4j.jar</em> in <em>WEB-INF/lib</em>
+ directory of your web-application instead of
+ <em>$TOMCAT_HOME/common/lib</em> where $TOMCAT_HOME stands for
+ the directory where Tomcat is installed. In order to fully
+ benefit from the stability offered by
+ <em>jcl104-over-slf4j.jar</em>, we recommend that you place
+ <em>jcl104-over-slf4j.jar</em> in
+ <em>$TOMCAT_HOME/common/lib</em> without placing a copy in
+ your web-applications.
+ </p>
+
+ <p>Please also see <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=22">bug
+ #22</a>.</p>
+
+ </explanation>
+
+ </message>
+
+ </body>
+</document>
\ No newline at end of file
Added: slf4j/trunk/slf4j-site/src/site/xdocs/docs.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/docs.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,27 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author>Ceki Gulcu</author>
+ <title>Documentation</title>
+ </properties>
+
+<body>
+
+ <h1>Documentation</h1>
+
+ <p>Given the small size of SLF4J, its documentation is not very
+ lengthy.</p>
+
+ <ul>
+ <li><a href="manual.html">User manual</a></li>
+ <li><a href="api/index.html">javadocs</a></li>
+ <li><a href="faq.html">FAQ</a></li>
+ </ul>
+
+</body>
+</document>
+
+
+
+
\ No newline at end of file
Added: slf4j/trunk/slf4j-site/src/site/xdocs/download.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/download.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,35 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author>Ceki Gulcu</author>
+ <title>Binary Files</title>
+ </properties>
+
+<body>
+
+
+ <h2>SLF4J version 1.1.0</h2>
+
+ <p>Download version 1.1.0 including <i>full source code</i>,
+ class files and documentation as
+ </p>
+
+ <ul>
+ <li><a href="dist/slf4j-1.1.0.tar.gz"><b>slf4j-1.1.0.tar.gz</b></a> </li>
+ <li><a href="dist/slf4j-1.1.0.zip"><b>slf4j-1.1.0.zip</b></a> </li>
+
+ </ul>
+
+ <h2>Previous versions</h2>
+
+ <p>Previous versions of SLF4J can be downloaded from the <A
+ href="dist/">main repository</A>.
+ </p>
+
+</body>
+</document>
+
+
+
+
\ No newline at end of file
Added: slf4j/trunk/slf4j-site/src/site/xdocs/index.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/index.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,60 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author email="ceki at qos ddoott ch ">Ceki Gulcu</author>
+ <title>Home</title>
+ </properties>
+
+
+<body>
+
+ <h1>Simple Logging Facade for Java (SLF4J)</h1>
+
+ <p>The Simple Logging Facade for Java or (SLF4J) is intended to
+ serve as a simple facade for various logging APIs allowing to the
+ end-user to plug in the desired implementation at
+ <em>deployment</em> time. SLF4J also allows for a <a
+ href="manual.html#gradual">gradual migration path</a> away from
+ Jakarta Commons Logging (JCL).
+ </p>
+
+ <p>Logging API implementations can either choose to implement the
+ the SLF4J interfaces directly, e.g. <a
+ href="http://logback.qos.ch">logback</a> or <a
+ href="api/org/slf4j/impl/SimpleLogger.html">SimpleLogger</a>. Alternatively,
+ it is possible (and rather easy) to write SLF4J adapters for the
+ given API implementation, e.g. <a
+ href="api/org/slf4j/impl/Log4jLoggerAdapter.html">Log4jLoggerAdapter</a>
+ or <a
+ href="api/org/slf4j/impl/JDK14LoggerAdapter.html">JDK14LoggerAdapter</a>..
+ </p>
+
+ <h2>Simplicity</h2>
+
+ <p>The SLF4J interfaces and their various adapters are simple and
+ straightforward. Most developers familiar with the Java language
+ should be able to read and fully understand the code in less than
+ one hour.
+ </p>
+
+ <p>SLF4J does not rely on any special class loader machinery. In
+ fact, the binding between SLF4J and a given logging API
+ implementation is performed <em>statically</em> at compile
+ time. Each binding is hardwired to use one and only specific logging
+ API implementation. Each binding corresponds to one jar file. At
+ deployment time, you simply drop the binding of your choice, that is
+ a jar file, onto the appropriate class path location. As a
+ consequence of this simple approach, SLF4J suffers from none of the
+ class loader problems or memory leaks observed with Jakarta Commons
+ Logging (JCL).
+ </p>
+
+ <p>We hope that simplicity of the SLF4J interfaces and the deployment
+ model will make it easy for developers of other logging APIs to
+ conform to the SLF4J model.
+ </p>
+
+</body>
+</document>
+
Added: slf4j/trunk/slf4j-site/src/site/xdocs/license.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/license.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,58 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author email="ceki at qos ddoott ch ">Ceki Gulcu</author>
+ <title>SLF4J License</title>
+ </properties>
+
+<body>
+
+ <h1>SLF4J License</h1>
+
+ <p>SLF4J source code and binaries are distributed under the
+ following license.
+ </p>
+
+ <p class="source">
+ Copyright (c) 2004-2005 SLF4J.ORG
+ Copyright (c) 2004-2005 QOS.ch
+
+ All rights reserved.
+
+ Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the
+ "Software"), to deal in the Software without restriction, including
+ without limitation the rights to use, copy, modify, merge, publish,
+ distribute, and/or sell copies of the Software, and to permit persons
+ to whom the Software is furnished to do so, provided that the above
+ copyright notice(s) and this permission notice appear in all copies of
+ the Software and that both the above copyright notice(s) and this
+ permission notice appear in supporting documentation.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+ OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+ HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY
+ SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER
+ RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
+ CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+ Except as contained in this notice, the name of a copyright holder
+ shall not be used in advertising or otherwise to promote the sale, use
+ or other dealings in this Software without prior written authorization
+ of the copyright holder.
+ </p>
+
+ <p>These terms are <em>identical</em> to those of the X11 License,
+ which is a simple, permissive non-copyleft free software license,
+ <em>compatible</em> with the <a
+ href="http://www.fsf.org/licensing/licenses/license-list.html#GPLCompatibleLicenses">
+ GNU GPL</a> as well as the <a
+ href="http://www.apache.org/licenses/">Apache Software License</a>.
+ </p>
+
+</body>
+</document>
\ No newline at end of file
Added: slf4j/trunk/slf4j-site/src/site/xdocs/mailing-lists.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/mailing-lists.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,114 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author email="">Ceki Gulcu</author>
+ <title>Mailing lists</title>
+ </properties>
+
+<body>
+
+ <h1>SLF4J Mailing Lists</h1>
+
+ <p>A mailing list is an electronic discussion forum that anyone can
+ subscribe to. When someone sends an email message to the mailing
+ list, a copy of that message is broadcast to everyone who is
+ subscribed to that mailing list. Mailing lists provide a simple and
+ effective communication mechanism. With potentially thousands of
+ subscribers, there is a common set of etiquette guidelines that you
+ should observe. Please keep on reading.
+ </p>
+
+ <h3>Respect the mailing list type</h3>
+
+ <p>The "User" lists where you can send questions and comments about
+ configuration, setup, usage and other "user" types of questions.
+ The "Developer" lists where you can send questions and comments
+ about the actual software source code and general "development"
+ types of questions.
+ </p>
+
+ <p>Some questions are appropriate for posting on both the "user" and
+ the "developer" lists. In this case, pick one and only one. Do not
+ cross post.
+ </p>
+
+ <p>Please do your best to ensure that you are not sending HTML or
+ "Stylelized" email to the list. If you are using Outlook or Outlook
+ Express or Eudora, chances are that you are sending HTML email by
+ default. There is usually a setting that will allow you to send
+ "Plain Text" email.
+ </p>
+
+<!--
+ <p>These lists are archived at
+
+ <ul>
+ <li><a href="http://logging.apache.org/mail/">Full mbox archives of all lists</a></li>
+ <li> <a href="http://nagoya.apache.org/eyebrowse/">Eyebrowse Archives</a></li>
+ <li>The Aims Group <a href="http://marc.theaimsgroup.com/">Archives</a></li>
+ </ul>
+ </p>
+-->
+
+
+
+ <h3>slf4j-announcements list</h3>
+
+ <p>
+ <b>Low Traffic:</b>
+ <a href="http://slf4j.org/mailman/listinfo/announce">Subscribe</a> |
+ <a href="http://slf4j.org/mailman/options/announce">Unsubscribe</a>
+ <br/>
+ <b>Archives:</b>
+ <a href="http://www.slf4j.org/pipermail/announce/">Pipermail</a> |
+ <a href="http://marc.theaimsgroup.com/?l=slf4j-announce">MARC</a>
+ </p>
+ <p>The announcements list is reserved for important SLF4J API or
+ NLOG4J related announcements. As such, the traffic on this list is
+ guaranteed to be very low.
+ </p>
+
+ <p>Given that implementations are expected to statically bind with
+ the SLF4J API, we recommend that any implementor of the SLF4J API
+ be subscribed at least to the announcements list.
+ </p>
+
+ <h3>slf4j-user list</h3>
+
+ <p>
+ <b>Medium Traffic:</b>
+ <a href="http://slf4j.org/mailman/listinfo/user">Subscribe</a> |
+ <a href="http://slf4j.org/mailman/options/user">Unsubscribe</a>
+ <br/>
+ <b>Archives:</b>
+ <a href="http://www.slf4j.org/pipermail/user/">Pipermail</a> |
+ <a href="http://news.gmane.org/gmane.comp.java.slf4j.user">Gmane</a> |
+ <a href="http://marc.theaimsgroup.com/?l=slf4j-user">MARC</a>
+
+ </p>
+
+ <p>This is the list for users of slf4j. It is also a good forum for
+ asking questions about how slf4j works, and how it can be
+ used. SLF4J developers are usually subscribed to to this list in
+ order to offer support.</p>
+
+
+ <h3>slf4j-dev list</h3>
+
+ <p>
+ <b>Medium Traffic:</b>
+ <a href="http://slf4j.org/mailman/listinfo/dev">Subscribe</a> |
+ <a href="http://slf4j.org/mailman/options/dev">Unsubscribe</a>
+ <br/>
+ <b>Archives:</b>
+ <a href="http://www.slf4j.org/pipermail/dev/">Pipermail</a> |
+ <a href="http://news.gmane.org/gmane.comp.java.slf4j.devel">Gmane</a> |
+ <a href="http://marc.theaimsgroup.com/?l=slf4j-dev">MARC</a> |
+ <a href="http://www.mail-archive.com/dev%40slf4j.org/">MailArchive</a>
+
+
+ </p>
+
+</body>
+</document>
Added: slf4j/trunk/slf4j-site/src/site/xdocs/manual.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/manual.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,261 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author email="">Ceki Gulcu</author>
+ <title>Welcome</title>
+ </properties>
+
+ <body>
+
+ <h1>SLF4J User manual</h1>
+
+ <p>The Simple Logging Facade for Java or (SLF4J) is intended to
+ serve as a simple facade for various logging APIs allowing to plug
+ in the desired implementation at deployment time.
+ </p>
+
+ <h2>Typical usage pattern</h2>
+
+ <pre class="source">
+ 1: <b>import org.slf4j.Logger;</b>
+ 2: <b>import org.slf4j.LoggerFactory;</b>
+ 3:
+ 4: public class Wombat {
+ 5:
+ 6: <b>final Logger logger = LoggerFactory.getLogger(Wombat.class);</b>
+ 7: Integer t;
+ 8: Integer oldT;
+ 9:
+10: public void setTemperature(Integer temparature) {
+11:
+12: oldT = t;
+13: t = temperature;
+14:
+15: <b>logger.debug("Temperature set to {}. Old temperature was {}.", t, oldT);</b>
+16:
+17: if(temperature.intValue() > 50) {
+18: <b>logger.info("Temperature has risen above 50 degrees.");</b>
+19: }
+20: }
+21: }
+ </pre>
+
+ <p>The example above illustrates the typical usage pattern for
+ SLF4j. Note the use of formatted log messages on line 15. See
+ the question <a href="faq.html#2.3">"What is the fastest way of
+ logging?"</a> in the FAQ for more details.
+ </p>
+
+ <h2>Swapping implementations at deployment time</h2>
+
+ <p>SLF4J currently supports multiple implementations, namely,
+ NOP, Simple, log4j version 1.2, log4j version 1.3, NLOG4J, JDK
+ 1.4 logging, JCL and LOGBack. The SLF4J distribution ships
+ with several jar files <em>slf4j-nop.jar</em>,
+ <em>slf4j-simple.jar</em>, <em>slf4j-log4j12.jar</em>,
+ <em>slf4j-log4j13.jar</em>, <em>slf4j-jdk14.jar</em> and
+ <em>slf4j-jcl.jar</em>. Each of these jar files is hardwired
+ <em>at compile-time</em> to use just one implementation, that
+ is NOP, Simple, log4j version 1.2, log4j version 1.3, JDK 1.4
+ logging, JCL and LOGBack, respectively.
+ </p>
+
+ <p>Small applications where configuring a fully-fledged
+ logging systems can be somewhat of an overkill can drop in
+ <em>slf4j-simple.jar</em> instead of a binding for the
+ fully-fledged logging system.
+ </p>
+
+ <p>Authors of widely-distributed components and libraries may
+ code against the SLF4J interface in order to avoid imposing an
+ logging API implementation on the end-user. At deployment
+ time, the end-user may choose the desired logging API
+ implementation by inserting the corresponding jar file in her
+ classpath. This stupid, simple and robust approach avoids many
+ of the painful bugs associated with dynamic discovery
+ processes.
+ </p>
+
+ <h2>Simplicity</h2>
+
+ <p>The SLF4J interfaces and their various adapters are
+ extremely simple. Most developers familiar with the Java
+ language should be able to read and fully understand the code
+ in less than one hour.
+ </p>
+
+ <p>As noted earlier, SLF4J does not rely on any special class
+ loader machinery. Every variant of
+ <em>slf4j-<impl>.jar</em> is statically hardwired <em>at
+ compile time</em> to use one and only specific
+ implementation. Thus, SLF4J suffers from none of the <a
+ href="http://www.qos.ch/logging/classloader.jsp">class loader
+ problems observed when using JCL</a>.</p>
+
+ <p>Hopefully, the simplicity of the SLF4J interfaces and the
+ deployment model will make it easy for developers of other
+ logging APIs to conform to the SLF4J model.
+ </p>
+
+ <h2>Built-in support in LOGBack</h2>
+
+ <p>The <code>Logger</code> class in LOGBack directly
+ implements SLF4J's <code>Logger</code> interface. Moreover,
+ LOGBack makes extensive use of SLF4J internally.
+ </p>
+
+ <p>LOGBack's built-in support for SLF4J means that the adapter
+ for does not need to wrap LOGBack objects in order to
+ make them conform to SLF4J's <code>Logger</code> interface. A
+ LOGBack <code>Logger</code> <em>is</em> a
+ <code>org.slf4j.Logger</code>. Thus, using SLF4J in
+ conjunction with LOGBack involves strictly zero memory overhead
+ and near-zero computational overhead.
+ </p>
+
+
+ <a name="gradual"><h2>Gradual migration to SLF4J from Jakarta
+ Commons Logging (JCL)</h2></a>
+
+ <h2><em>jcl104-over-slf4j.jar</em></h2>
+
+ <p>To ease migration to SLF4J from JCL, recent SLF4J
+ distributions include the jar file
+ <em>jcl104-over-slf4j.jar</em>. This jar file is intended as a
+ drop-in replacement for JCL version 1.0.4. It implements the
+ public API of JCL but using SLF4J underneath, hence the name
+ "JCL over SLF4J."
+ </p>
+
+ <p>Our JCL over SLF4J implementation will allow you to migrate
+ to SLF4J gradually, especially if some of the libraries your
+ software depends on continue to use JCL for the foreseeable
+ future. You can immediately enjoy the benefits of SLF4J's
+ reliability and preserve backward compatibility at the same
+ time. Just replace <em>commons-logging.jar</em> with
+ <em>jcl104-over-slf4j.jar</em>. Subsequently, the selection of
+ the underlying logging system will be done by SLF4J instead of
+ JCL but without the class loader headaches. The underlying
+ logging system can be any of NOP, simple, jdk14 logging, log4j
+ or LOGBack. Any existing dependency on commons-logging
+ therefore becomes less of an issue.
+ </p>
+
+ <h2><em>slf4j-jcl.jar</em></h2>
+
+ <p>Some of our users after having switched to SLF4J API
+ realize that in some contexts the use of JCL is mandatory and
+ their use of SLF4J can be a problem. For this uncommon but
+ important case, SLF4J offers a JCL binding, found in the file
+ <em>slf4j-jcl.jar</em>. The JCL binding will delegate all
+ logging calls made through SLF4J API to JCL. Thus, if for some
+ reason an existing application <em>must</em> use JCL, your
+ part of that application can still code against the SLF4J API
+ in a manner transparent to the larger application
+ environment. Your choice of SLF4J API will be invisible to the
+ rest of the application which can continue to use JCL.
+ </p>
+
+ <h2><em>jcl104-over-slf4j.jar</em> should not be confused with
+ <em>slf4j-jcl.jar</em></h2>
+
+
+ <p>JCL-over-SLF4J, i.e. <em>jcl104-over-slf4j.jar</em>, comes
+ in handy in situations where JCL needs to be supported for
+ backward compatibility reasons. It can be used to fix problems
+ associated with JCL, without necessarily adopting the SLF4J
+ API, a decision which can be deferred to a later time.
+ </p>
+
+ <p>On the other hand, <em>slf4j-jcl.jar</em> is useful after
+ you have already adopted the SLF4J API for your component
+ which needs to be embedded in a larger application environment
+ where JCL is a formal requirement. Your software component can
+ still use SLF4J API without disrupting the larger
+ application. Indeed, <em>slf4j-jcl.jar</em> will delegate all
+ logging decisions to JCL so that the dependency on SLF4J API
+ by your component will be transparent to the larger whole.
+ </p>
+
+ <p>Please note that <em>jcl104-over-slf4j.jar</em> and
+ <em>slf4j-jcl.jar</em> cannot be deployed at the same
+ time. The former jar file will cause JCL to delegate the
+ choice of the logging system to SLF4J and the latter jar file
+ will cause SLF4J to delegate the choice of the logging system
+ to JCL, resulting in an infinite loop.
+ </p>
+
+ <a name="summary"><h2>Summary</h2></a>
+
+ <table class="ls" cellspacing="4" cellpadding="4">
+ <tr>
+ <th align="left">Advantage</th>
+ <th align="left">Description</th>
+ </tr>
+
+ <tr>
+ <td>Swappable logging API implementations</td>
+ <td>The desired logging API can be plugged in at
+ deployment time by inserting the appropriate jar file on
+ your classpath.
+ </td>
+ </tr>
+
+
+ <tr>
+ <td>Fail-safe operation</td>
+ <td>Assuming the appropriate jar file is available on the
+ classpath, under no circumstances will SLF4J cause your
+ application to fail. SLF4J's simple and robust design
+ ensures that SLF4J never causes exceptions to be thrown.
+
+ <p>Contrast this with
+ <code>LogConfigurationException</code> thrown by JCL which
+ will cause your otherwise functioning application to
+ fail. JCL-logging will throw a
+ <code>LogConfigurationException</code> in case the <a
+ href="http://jakarta.apache.org/commons/logging/api/org/apache/commons/logging/Log.html">Log</a>
+ interface and its dynamically discovered implementation
+ are loaded by different class loaders.
+ </p>
+ </td>
+ </tr>
+
+
+ <tr>
+ <td>Adapter implementations for popular logging systems
+ </td>
+
+ <td>SLF4J supports popular logging systems, namely log4j,
+ JDK 1.4 logging, Simple logging and NOP.
+ </td>
+ </tr>
+
+ <tr>
+ <td>Easy migration path</td>
+ <td>The implementation of JCL over SLF4J will allow your
+ project to migrate to SLF4J piecemeal, without breaking
+ compatibility with existing software, while enhancing the
+ reliability of your software at the same time.
+
+ <p>In existing applications where JCL is a requirement,
+ the JCL binding will allow parts of that application to
+ switch to SLF4J without having any impact on the larger
+ application.</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td>Support for formated log messages</td>
+
+ <td>All SLF4J adapters support formated log messages with
+ significantly improved performace results.</td>
+ </tr>
+
+
+ </table>
+
+</body>
+</document>
+
Added: slf4j/trunk/slf4j-site/src/site/xdocs/news.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/news.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,472 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author email="not at disclosed">Ceki Gulcu</author>
+ <title>News</title>
+ </properties>
+
+<body>
+
+ <h1>SLF4J News</h1>
+
+ <p>You can receive SLF4J and NLOG4J related announcements by
+ subscribing to the <a
+ href="http://www.slf4j.org/mailman/listinfo/announce">SLF4J
+ announce</a> mailing list.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>July 25th, 2006 - Release of SLF4J 1.1.0</h3>
+
+ <p>Release 1.1.0 is a relatively important
+ only.</p>
+
+ <ul>
+
+ <li>Fixed <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=22">bug number
+ 22</a> reported by Bjorn Danielsson. This version of the SLF4J API
+ will no longer systematically throw an exception when the
+ <code>o.a.c.l.impl.SLF4FLogFactory#release()</code> method is
+ invoked. Instead, the <code>release()</code> method will issue a
+ <a href="http://www.slf4j.org/codes.html">warning</a>.
+
+ </li>
+
+ </ul>
+
+
+ <hr noshade="noshade" size="1"/>
+
+
+ <h3>June 8th, 2006 - Release of SLF4J 1.0.2</h3>
+
+ <p>Release 1.0.2 is a maintenance release containing bug fixes
+ only.</p>
+
+ <ul>
+
+ <li>Fixed <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=22">bug number
+ 22</a> reported by Bjorn Danielsson. This version of the SLF4J API
+ will no longer systematically throw an exception when the
+ <code>o.a.c.l.impl.SLF4FLogFactory#release()</code> method is
+ invoked. Instead, the <code>release()</code> method will issue a
+ <a href="http://www.slf4j.org/codes.html">warning</a>.
+
+ </li>
+
+ </ul>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>May 1st, 2006 - Release of SLF4J 1.0.1</h3>
+
+ <p>Release 1.0.1 is a maintenance release containing bug fixes only.
+
+ <ul>
+
+ <li>Fixed <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=20">bug number
+ 20</a> reported by Steve Bate. <code>JDK14LoggerAdapter</code>
+ will now correctly relay the logger name to the underlying JDK 14
+ logging system.
+ </li>
+
+ <li>Added the file "org.apache.commons.logging.LogFactory" under
+ META-INF/services directory in the jcl104-over-slf4j jar
+ file. This fixes a compatibility problem with Apache Axis which
+ uses its own discovery mechanism, namely, commons-discovery
+ version 0.2. The bug was reported by Dave Wallace.
+ </li>
+
+ </ul>
+ </p>
+
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>March 8th, 2006 - Release of SLF4J 1.0</h3>
+
+ <p>This is release labeled as 1.0 (final) contains few relatively
+ minor changes:
+ </p>
+
+ <ul>
+ <li>As <a
+ href="http://marc.theaimsgroup.com/?t=114063163800004">discussed</a>
+ on the slf4j user list, <code>SimpleLogger</code> now directs its
+ output to stderr instead of stdout.
+ </li>
+
+ <li>Modified <code>JDK14LoggerAdapter</code> so that caller
+ information is now correctly printed, as reported in <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=13">bug 13</a> by
+ Peter Royal.
+ </li>
+
+ <li>Minor additions to the Marker interface.</li>
+
+ </ul>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>February 4th, 2006 - Release of SLF4J 1.0-RC6 and NLOG4J
+ 1.2.22</h3>
+
+ <p>The <code>MarkingLogger</code> interface has been removed and its
+ contents merged into <code>org.slf4j.Logger</code>. This change
+ should not adversely affect end-users. However, SLF4J bindings need
+ to be updated. This has been done for all the bindings shipped with
+ SLF4J distribution as well as NLOG4J. As for x4juli, the update is
+ planned for its next release.
+ </p>
+
+ <p>The merge between the <code>MarkingLogger</code> and
+ <code>Logger</code> interfaces has been motivated by the need to
+ allow end-users to easily switch between logging systems that
+ support markers and those that do not.
+ </p>
+
+ <p>Added a default instance to SimpleLoggerFactory to serve as a
+ last resort fallback mechanism. This instance is designed to be used
+ by a very specific group of users, namely for those developing
+ logging systems (e.g. log4j or LOGBack). It is not intended for
+ end-users of the SLF4J API.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>January 9th, 2006 - Release of SLF4J 1.0-RC5 and NLOG4J
+ 1.2.21</h3>
+
+ <p>A maintenance release correcting bugs <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=11">#11</a> and <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=12">#12</a> and in
+ general improved resilience to null input parameters across
+ implementations. Many thanks to Boris Unckel and Kenneth for
+ reporting the null input issue.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>December 27th, 2005 - Release of SLF4J 1.0-RC4 and NLOG4J
+ 1.2.20</h3>
+
+
+ <p>The printing methods in <code>org.slf4j.Logger</code> interface
+ now support passing 3 or more parameters in an <code>Object</code>
+ array. This was a frequently requested feature missing in previous
+ versions of SLF4J.
+ </p>
+
+ <p>NLOG4J 1.2.20 reflects the addition of new methods in the
+ <code>org.slf4j.Logger</code> interface.</p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>December 8th, 2005 - Release of SLF4J 1.0-RC3</h3>
+
+ <p>Maintenance release fixing reported bugs <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=6">#6</a> and <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=7">#7</a>.
+ </p>
+
+
+ <h3>November 28th, 2005 - Release of SLF4J 1.0-RC2</h3>
+
+ <p>In response to a request by Greg Wilkins, this release adds the
+ jar file <em>slf4j-jcl.jar</em>, an SLF4J binding for JCL. Please
+ read the <a href="manual.html#gradual">gradual migration section</a>
+ in the manual for more details.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>November 21st, 2005 - Release of SLF4J 1.0-RC1</h3>
+
+ <p>A maintenance release correcting bugs <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=4">#4</a> and <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=5">#5</a>. Many
+ thanks to Christian Beil for accurately reporting bug #4.
+ </p>
+
+ <p>There has been also an effort to minimize the file sizes of the
+ various jar files produced by SLF4J, resulting in jar files
+ approximately 40% smaller than in version 1.0beta9.
+ </p>
+
+ <p>Given that the SLF4J API is now deemed stable, this release is
+ marked as RC1, that is release candidate number 1.
+ </p>
+
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>October 19th, 2005 - Release of SLF4J 1.0-beta9</h3>
+
+ <p>The SLF4J distribution now includes two distinct bindings
+ <em>slf4j-log4j12.jar</em> and <em>slf4j-log4j13.jar</em> in order
+ to differentiate between log4j version 1.2 and version 1.3. This
+ distinction is absolutely necessary because log4j 1.2 and 1.3 are
+ not run-time compatible, although they are mostly compile-time
+ compatible.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>October 19th, 2005 - Release of SLF4J 1.0-beta8 and NLOG4J 1.2.18</h3>
+
+
+ <p>Added a new SLF4J binding, <em>slf4j-log4j.jar</em>, intended to
+ be used in conjunction with vanilla <em>log4j.jar</em>, as
+ distributed by the <a href="http://logging.apache.org">Apache
+ Logging Services</a> project. The slf4j-log4j binding is quite
+ similar in structure to the JDK 1.4 binding that existed
+ previously.
+ </p>
+
+ <p>The slf4j-log4j binding addresses compatibility problems which
+ arose when copies of both <em>log4j.jar</em> and <em>nlog4j.jar</em>
+ lay on the class path, in particular when it was undesirable or
+ impossible to remove the preexisting <em>log4j.jar</em> file.
+ </p>
+
+ <p>Methods in the <code>org.slf4j.Logger</code> interface related to
+ markers were moved to a separate super interface called <a
+ href="api/org/slf4j/MarkingLogger.html">
+ <code>org.slf4j.MarkingLogger</code></a>. This refactoring reduces
+ the weight of the <a href="api/org/slf4j/Logger.html">
+ <code>Logger</code></a> interface.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>August 28th, 2005 - Release of SLF4J 1.0-beta7 and NLOG4J 1.2.17</h3>
+
+ <p>Spurred by <a
+ href="http://bugzilla.slf4j.org/show_bug.cgi?id=3">bug report
+ #3</a>, SLF4J binding code has been refactored and
+ simplified. Logging systems implementing SLF4J interfaces have to
+ have less work in order to bind with SLF4J. Moreover, these changes
+ have no incidence on the published interface of SLF4J.
+ </p>
+
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>August 26th, 2005 - Release of SLF4J 1.0-beta6</h3>
+
+ <p>To ease migration to SLF4J from JCL, this release includes a jar
+ file called <em>jcl-over-slf4j-1.0.4.jar</em>. This jar file can be
+ used as drop-in replacement for JCL version 1.0.4. It implements the
+ public API of JCL using SLF4J underneath.
+ </p>
+
+ <p>Thus, you can immediately benefit from the advantages of SLF4J
+ without waiting for all the libraries you depend on to migrate to
+ SLF4J first.</p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>August 16th, 2005 - Release of NLOG4J 1.2.16</h3>
+
+ <p>This release adds solves a compatibility problem between log4j
+ and nlog4j. Previous to this release, code compiled with log4j
+ would not run correctly with nlog4j.
+ </p>
+
+ <p>With the fixes introduced in NLOG4J 1.2.16, code compiled with
+ log4j 1.2.x will run without problems when deployed using NLOG4j.
+ </p>
+
+ <p>However, the inverse is not true. Code compiled with nlog4j can
+ only be deployed using nlog4j.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>August 12th, 2005 - Release of SLF4J 1.0-beta5 and NLOG4J
+ 1.2.15</h3>
+
+ <p>This release adds support for the <a
+ href="api/org/slf4j/Marker.html">Marker</a> interface. Thus, log
+ statements can be decorated with Marker data allowing more
+ expressive power in the processing of log statements.
+ </p>
+
+ <p>For the sake of IoC frameworks, <code>Logger</code> instances can
+ new be queried for their <a
+ href="api/org/slf4j/Logger.html#getName()">name</a>.
+ </p>
+
+ <p>With the addition of markers, sub-domains are no longer
+ needed.</p>
+
+ <p>The <code>LoggerFactoryAdapter</code> has been simplified and
+ renamed as <a
+ href="api/org/slf4j/ILoggerFactory.html"><code>ILoggerFactory</code></a>.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>July 5th, 2005 - Release of NLOG4J 1.2.14</h3>
+
+ <p>This release fixes compatibility problems between NLOG4J and
+ Jakarta Commons Logging.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>June 28th, 2005 - Release of SLF4J 1.0-beta4 and NLOG4J
+ 1.2.13</h3>
+
+ <p>Following discussions on the SLF4J developers list, the
+ signatures of the printing methods in <a
+ href="api/org/slf4j/Logger.html"><code>org.slf4j.Logger</code></a>
+ interface have been modified to admit messages of type
+ <code>String</code> instead of type <code>Object</code> as
+ previously. The current set of printing methods is listed below.
+ </p>
+
+ <pre class="source">
+ void debug(String msg);
+ void debug(String format, Object arg);
+ void debug(String format, Object arg1, Object arg2);
+ void debug(String msg, Throwable t);
+
+ void error(String msg);
+ void error(String format, Object arg;)
+ void error(String format, Object arg1, Object arg2);
+ void error(String msg, Throwable t);
+
+ void info(String msg);
+ void info(String format, Object arg);
+ void info(String format, Object arg1, Object arg2);
+ void info(String msg, Throwable t);
+
+ void warn(String msg);
+ void warn(String format, Object arg);
+ void warn(String format, Object arg1, Object arg2);
+ void warn(String msg, Throwable t); </pre>
+
+
+ <p>NLOG4J release 1.2.13 reflects changes in the SLF4J API.
+ </p>
+
+ <p>You can download SLF4J and NLOG4J, including full source code,
+ class files and documentation on our <a
+ href="download.html">download page</a>.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>May 17th, 2005 - SLF4J version 1.0-beta-3 released</h3>
+
+ <p>In response to user comments, the <code>org.slf4j.ULogger</code>
+ interface has been renamed as <code>org.slf4j.Logger</code>.
+ </p>
+
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>May 17th, 2005 - NLOG4J version 1.2.12 released</h3>
+
+ <p>SLF4J.ORG is proud to release NLOG4J 1.2.12, a log4j-replacement
+ with native SLF4J API support. Except for users of LF5, chainsaw or
+ <code>NTEvenAppender</code>, NLOG4J should be considered as a 100%
+ compatible, drop-in replacement for log4j version 1.2.9.
+ </p>
+
+ <p>This release reflects changes in the SLF4J API, i.e renaming of
+ <code>org.slf4j.ULogger</code> interface as
+ <code>org.slf4j.Logger</code>.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>May 17th, 2005 - SLF4J version 1.0-beta-3 released</h3>
+
+ <p>SLF4J.ORG is proud to release SLF4J 1.0-beta-3. In response to
+ user comments, the <code>org.slf4j.ULogger</code> interface has been
+ renamed as <code>org.slf4j.Logger</code>.
+ </p>
+
+ <p>You can download SLF4J, including full source code, class files
+ and documentation on our <a href="download.html">download page</a>.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>May 14th, 2005 - NLOG4J version 1.2.11 released</h3>
+
+ <p>SLF4J.ORG is proud to release NLOG4J 1.2.11, a log4j-replacement
+ with native SLF4J API support. Except for users of LF5, chainsaw or
+ <code>NTEvenAppender</code>, NLOG4J should be considered as a 100%
+ compatible, drop-in replacement for log4j version 1.2.9.
+ </p>
+
+ <p>You can download NLOG4J version 1.2.11, including full source
+ code, class files and documentation on our <a
+ href="download.html">download page</a>.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>May 4th, 2005 - SLF4J version 1.0-beta-2 released</h3>
+
+ <p>SLF4J.ORG is proud to release SLF4J 1.0-beta-2. This release
+ contains cosmetic or javadoc changes. For example, the project has a
+ new logo.
+ </p>
+
+ <p>You can download SLF4J version 1.0-beta2, including full source
+ code, class files and documentation on our <a
+ href="download.html">download page</a>.
+ </p>
+
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>1 May 2005 - not-log4j-1.2.10 released</h3>
+
+ <p>Subsequent to the recall of log4j 1.2.10, SLF4J.ORG releases
+ non-log4j-1.2.10 for those interested in SLF4J support in log4j.
+ </p>
+
+ <p>You can download not-log4j version 1.2.10, including full source
+ code, class files and documentation on our <a
+ href="download.html">download page</a>.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+
+ <h3>22 April 2005 - SLF4J project goes live</h3>
+
+ <p>The SLF4J project site, including SVN repositories go
+ live. Users can download SLF4J version 1.0-beta1.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>15 April 2005 - start of work on SLF4J source code</h3>
+
+ <p>Start of work on the SLF4j source code.
+ </p>
+
+ <hr noshade="noshade" size="1"/>
+
+ <h3>13 April 2005 - start of work on SLF4J project</h3>
+
+ <p>Launch of the SLF4J project. Work has begun on the web-site, svn
+ repositories as well as the source code.
+ </p>
+
+
+
+
+</body>
+</document>
\ No newline at end of file
Added: slf4j/trunk/slf4j-site/src/site/xdocs/svn.xml
==============================================================================
--- (empty file)
+++ slf4j/trunk/slf4j-site/src/site/xdocs/svn.xml Mon Sep 4 21:50:39 2006
@@ -0,0 +1,75 @@
+<?xml version="1.0"?>
+<document>
+
+ <properties>
+ <author email="ceki at qos ddoott ch ">Ceki Gulcu</author>
+ <title>Source code repositories</title>
+ </properties>
+
+<body>
+
+ <h1>Source code repositories</h1>
+
+ <p>SLF4j developers are live in different countries throughout the
+ world. To enable them to work together, we keep the source code in
+ revision control systems called Subversion. Developers have write
+ access to the Subversion repository, enabling them to make changes
+ to the source code. Everyone has read access to the repositories, so
+ you may download the most up-to-date development version of the
+ software. Note that the latest version in the Subversion repository
+ many not work as expected, it may not even compile properly. If you
+ are looking for a stable release of the source code, you should
+ download an official distribution instead of the latest version in
+ the Subversion repositories.
+ </p>
+
+
+ <p>There are several ways to access the Subversion repositories:</p>
+
+ <h2>Web Access</h2>
+
+ <p>If you just wish to browse around or download a few individual
+ files, the best tool is the web-based ViewCVS interface for CVS
+ repositories and ViewCVS interface for Subversion or go straight to
+ the public repositories at:
+ </p>
+
+ <table cellspacing="6">
+ <tr>
+ <td>For SLF4J </td>
+ <td><a href="http://svn.slf4j.org/viewcvs/slf4j/trunk/">
+ http://svn.slf4j.org/viewcvs/slf4j/trunk/</a>
+ </td>
+ </tr>
+
+ <tr>
+ <td>For NLOG4J </td>
+ <td><a href="http://svn.slf4j.org/viewcvs/nlog4j/trunk/">
+ http://svn.slf4j.org/viewcvs/nlog4j/trunk/</a>
+ </td>
+ </tr>
+ </table>
+
+ <h2>Checking out a read-only copy</h2>
+
+
+ <p>To access the Subversion repositories anonymously, you will need
+ a Subversion client.
+ </p>
+
+ <p>To check out the SLF4j module, issue the following command: </p>
+
+ <pre class="cmd">svn checkout <b>http://svn.slf4j.org/repos/slf4j/trunk</b></pre>
+
+
+ <p>To check out the NLOG4J module, issue the following command: </p>
+
+ <pre class="cmd">svn checkout <b>http://svn.slf4j.org/repos/nlog4j/trunk</b></pre>
+
+ <p>Note that anonymous access allows read-only access only. For
+ read-write access please contact the <a
+ href="http://slf4j.org/mailman/listinfo/dev">slf4j developer list</a>.
+ </p>
+
+</body>
+</document>
\ No newline at end of file
More information about the slf4j-dev
mailing list