Initial cut at releasenotes for next release.
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@190898 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Simon Kitching
@@ -1,6 +1,6 @@
|
||||
<!--
|
||||
|
||||
Copyright 2001-2004 The Apache Software Foundation.
|
||||
Copyright 2005 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.
|
||||
@@ -19,94 +19,77 @@
|
||||
$Id$
|
||||
|
||||
Commons Logging Package
|
||||
Version 1.0.4
|
||||
Version 1.1.0
|
||||
Release Notes
|
||||
|
||||
|
||||
INTRODUCTION:
|
||||
============
|
||||
|
||||
This document contains the release notes for this version of the Commons
|
||||
Logging package. It is primarily a service release for downstream users.
|
||||
The main emphasis maintenance and code cleanup release,
|
||||
with some new features including support for both the old 1.2.x series
|
||||
of Log4J releases and the new 1.3.x series of releases.
|
||||
This release introduces significant changes in the way that discovery of
|
||||
logging implementations occurs, and how errors are handled. A number of
|
||||
problems that have troubled users in past releases (particularly the
|
||||
"Log4JLogger does not implement Log" problem) will hopefully be
|
||||
significantly reduced or cured.
|
||||
|
||||
The following paragraphs document changes since the previous release
|
||||
(version 1.0.3). The documentation (userguide and javadoc)
|
||||
has also been improved.
|
||||
This release is 100% compatible with existing code that calls
|
||||
commons-logging. There are some incompatibilities with code that extends
|
||||
commons-logging, for example to implement custom logging adapters.
|
||||
|
||||
== New Features ==
|
||||
|
||||
* jars now have release-numbers embedded in the names
|
||||
* commons-logging-adapters-xxx.jar now included.
|
||||
* creation of optional jar containing WeakHashtable implementation
|
||||
Changes to LogFactory to use a WeakHashtable if one is available.
|
||||
|
||||
* added internal diagnostics feature. If commons-logging is behaving in an
|
||||
unexpected manner, you can now set system property
|
||||
org.apache.commons.logging.diagnostics.dest
|
||||
to the value STDOUT, STDERR or a filename. As commons-logging initialises
|
||||
itself for each new contextClassLoader it detects, useful information will
|
||||
be output about which logging library is bound to and why.
|
||||
|
||||
* new configurable attributes ALLOW_FLAWED_HIERARCHY, ALLOW_FLAWED_DISCOVERY and
|
||||
ALLOW_FLAWED_CONTEXT. The default values for these are all true, meaning that
|
||||
commons-logging attempts to recover from bad logging configuration situations
|
||||
by finding *some* logger to use even when it isn't quite the one that might
|
||||
be expected. This will significantly reduce the occurrence of the dreaded
|
||||
LogConfigurationException on application/webapp startup at the cost of
|
||||
slightly more ambiguity about where output will go. In cases where no logging
|
||||
output is generated or wanted (which is the case 99% of the time) this is definitely a
|
||||
more convenient approach. Users who cannot figure out where logging went or
|
||||
why it went to an unexpected destination can enable diagnostics to find out,
|
||||
or set the ALLOW_FLAWED_ settings to false to force LogConfigurationException
|
||||
to be thrown as in earlier releases.
|
||||
|
||||
|
||||
NEW FEATURES:
|
||||
============
|
||||
* ServletContextCleaner class now provided to ensure memory is released
|
||||
when undeploying webapps. This does require an entry in the webapp
|
||||
deployment descriptor to enable.
|
||||
|
||||
[ALL FILES] This version of Commons Logging is released under the
|
||||
Apache License (Version 2.0). All source files have been
|
||||
modified to reflect this.
|
||||
|
||||
[maven.xml] Added beginnings of a Maven-based build, primarily for the
|
||||
purpose of creating documentation consistent with Mavenized
|
||||
commons projects. The official build system for the software
|
||||
is still the Ant "build.xml" file.
|
||||
== Bugs Fixed ==
|
||||
|
||||
[AvalonLogger] Added AvalonLogger, which wraps the logger used by the
|
||||
Avalon framework. As with other implementations, this
|
||||
is compiled only if the appropriate dependencies are
|
||||
satisfied. This implementation is *NOT* Serializable
|
||||
* 31597: problem where log4j adapter in parent classloader but log4j.jar was
|
||||
in child classloader led to failure to initialise logging has been
|
||||
fixed.
|
||||
|
||||
[Jdk13LumberjackLogger]
|
||||
Added Jdk13LumberjackLogger, which wraps the implementation
|
||||
of the JSR-47 logging APIs (for JDKs before 1.4) provided
|
||||
by the SourceForge "lumberjack" project.
|
||||
<http://sourceforge.net/projects/lumberjack/>
|
||||
* 31710, 10825: commons-logging now works better in systems where getClassLoader
|
||||
returns null. This essentially means embedded systems.
|
||||
|
||||
[LogFactoryImpl] If an InvocationTargetException is returned during the
|
||||
creation of a new Log instance, unwrap the underlying
|
||||
cause and pass it in to the LogConfigurationException
|
||||
constructor. This will make the actual cause of the
|
||||
problem easier to diagnose.
|
||||
* 31818: workaround for bug in java1.2 compiler; code now compiles under 1.2
|
||||
|
||||
[LogFactoryImpl] If the isAssignableFrom() test fails because there is more
|
||||
than one instance of org.apache.commons.logging.Log visible
|
||||
in the class loader hierarchy, make the exception message
|
||||
that is reported explicitly state this, rather than the
|
||||
potentially misleading claim that an implementation class
|
||||
does not implement Log.
|
||||
* Log4JCategoryLog has been removed from the main distribution jar; it has been
|
||||
deprecated for a long while. Replacement class Log4JLogger should be a completely
|
||||
transparent replacement for all commons-logging users.
|
||||
|
||||
[Log4JLogger] Changes to allow this logger to support both the existing 1.2.x
|
||||
series of releases and also the upcoming 1.3.x series of Log4J
|
||||
releases.
|
||||
|
||||
[SimpleLog] Added support for setting date-time format.
|
||||
|
||||
BUG FIXES:
|
||||
=========
|
||||
|
||||
[MANIFEST.MF] Remove reference to Log4J from the manifest classpath.
|
||||
|
||||
[LogConfigurationException]
|
||||
Include root cause in the text of the message, if present.
|
||||
|
||||
[LogFactory] Improve usability of error messages reporting
|
||||
configuration problems.
|
||||
|
||||
[JDK14Logger] Implement Serializable, remove "final" declaration for
|
||||
easy subclassing.
|
||||
|
||||
[Log4JLogger] Implement Serializable, remove "final" declaration for
|
||||
easy subclassing.
|
||||
|
||||
[NoOpLogger] Implement Serializable, remove "final" declaration for
|
||||
easy subclassing.
|
||||
|
||||
[SimpleLog] Make SimpleLog more friendly to the security manager
|
||||
in an applet environment, by swallowing any security
|
||||
exceptions when looking up system properties that are
|
||||
not accessible.
|
||||
|
||||
[AvalonLogger] Fix NullPointerException when it when providing a
|
||||
default logger.
|
||||
* package.html files are no longer present in the jarfiles, removing nuisance
|
||||
javadoc warnings when building javadoc for apps using jcl.
|
||||
|
||||
* In several cases, LogConfigurationException objects were being wrapped in
|
||||
other LogConfigurationException objects. These have (hopefully) all been
|
||||
fixed.
|
||||
|
||||
DEPRECATIONS:
|
||||
============
|
||||
@@ -120,7 +103,3 @@ DEPRECATIONS:
|
||||
purpose. The class is now deprecated, and the proxy
|
||||
instance is no longer created.
|
||||
|
||||
[Log4JCategoryLog] This class has been replaced by Log4JLogger, which
|
||||
corresponds to the availability of the new Logger class
|
||||
in Log4J 1.2 and later.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user