Author: apetrelli
Date: Thu Jul 15 14:51:46 2010
New Revision: 964454
URL: http://svn.apache.org/viewvc?rev=964454&view=rev
Log:
VELOCITYSB-4
Modified WHY_TWO_JARS.txt into WHY_FIVE_JAR.txt
Added:
velocity/sandbox/maven-reorg/engine/trunk/WHY_FIVE_JARS.txt
- copied, changed from r961428,
velocity/sandbox/maven-reorg/engine/trunk/WHY_TWO_JARS.txt
Removed:
velocity/sandbox/maven-reorg/engine/trunk/WHY_TWO_JARS.txt
Copied: velocity/sandbox/maven-reorg/engine/trunk/WHY_FIVE_JARS.txt (from
r961428, velocity/sandbox/maven-reorg/engine/trunk/WHY_TWO_JARS.txt)
URL:
http://svn.apache.org/viewvc/velocity/sandbox/maven-reorg/engine/trunk/WHY_FIVE_JARS.txt?p2=velocity/sandbox/maven-reorg/engine/trunk/WHY_FIVE_JARS.txt&p1=velocity/sandbox/maven-reorg/engine/trunk/WHY_TWO_JARS.txt&r1=961428&r2=964454&rev=964454&view=diff
==============================================================================
--- velocity/sandbox/maven-reorg/engine/trunk/WHY_TWO_JARS.txt (original)
+++ velocity/sandbox/maven-reorg/engine/trunk/WHY_FIVE_JARS.txt Thu Jul 15
14:51:46 2010
@@ -1,10 +1,10 @@
WHY ARE THERE TWO JARS? WHAT'S THE DIFFERENCE?
===============================================
-We are including two jars with the Velocity distribution. This
+We are including five jars with the Velocity distribution. This
document describes the differences and what they are intended for.
-Both jars are included in the root directory of the Velocity
+All of the jars are included in the root directory of the Velocity
distribution.
CAVEAT: Up and including the 1.4 release of Velocity, there was a
@@ -13,19 +13,20 @@ runtime or the tools. This lead to some
the purpose of the various jars.
Starting with the 1.5 release of Velocity, there is now one jar,
-velocity-<version>.jar, which contains all Velocity code and a second
-jar, velocity-dep-<version>.jar, which contains all Velocity code and
-its external dependencies.
+velocity-<version>.jar, which contains all Velocity code, and four
+jars, velocity-engine-<module>-<version>.jar, which contains some specific
Velocity
+code.
velocity-<version>.jar
----------------------
- This jar contains only the velocity specific code in the
- org.apache.velocity.* packages.
+ This jar contains all the velocity specific code in the
+ org.apache.velocity.* packages.
- If you want to integrate Velocity in your own code or a larger
- project, we recommend that you use this jar.
+ If you want to integrate Velocity easily in your own code or a larger
+ project and you are not in a Maven environment, we recommend that you use
+ this jar.
It has some external dependencies which are listed in the developer
docs. Make sure that you have these dependencies present in your
@@ -34,37 +35,28 @@ velocity-<version>.jar
Please see the developers guide for more information.
-velocity-dep-<version>.jar
+velocity-engine-core-<version>.jar
--------------------------
- This jar is intended to be used when you do standalone development
- with Velocity. It contains all of the Velocity engine code (runtime,
- anakia, texen and their respective ant tasks) and also all external
- dependencies from other jars, repackaged into a single jar. Currently
- that is:
+ This jar contains only the main part of Velocity. Useful if you don't need
+ special logging requisites (it works fine with JDK 1.4 logger).
- oro org.apache.oro.* packages,
- from http://jakarta.apache.org/oro/
-
- commons-lang org.apache.commons.lang.* packages,
- from http://jakarta.apache.org/commons/lang/
-
- Avalon Logkit org.apache.log.* packages
+velocity-engine-commons-logging-<version>.jar
+--------------------------
- and a subset of
+ This jar contains the Commons Logging Log Chute, that allows logging using
+ Commons Logging.
+ It needs to be used together with velocity-engine-core-<version>.jar
- commons-collections org.apache.commons.collections.* packages
- from http://jakarta.apache.org/commons/collections/
+velocity-engine-log4j-<version>.jar
+--------------------------
- These classes are strictly intended for Velocity use! If you want to use
- the velocity-dep jar, do not rely on any of the other classes being present.
- We reserve the right to change the supporting classes (those not in the
- org.apache.velocity.* packages) at any time for any release.
+ This jar contains the Log4J Log Chute, that allows logging using Log4j.
+ It needs to be used together with velocity-engine-core-<version>.jar
- When using this jar without anything else, you are also restricted to
- using the Avalon Logkit for logging (or JDK 1.4 logging if you run under
- JDK 1.4 or newer).
+velocity-engine-servlet-logger-<version>.jar
+--------------------------
- This jar should only be used for the Velocity runtime. The various tools
- (Anakia, Texen, Webmacro converter) have additional dependencies that are
- not inside this jar!
+ This jar contains the Servlet Logger Log Chute, that allows logging using
+ logging methods provided by servlets.
+ It needs to be used together with velocity-engine-core-<version>.jar
