cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [16/19] cayenne git commit: CAY-2280 upgrade docs files
Date Wed, 26 Apr 2017 10:09:30 GMT
CAY-2280 upgrade docs files


Branch: refs/heads/master
Commit: 1f17edbae73402ca0336e919b50f8b8f8c3ca1d5
Parents: 04ab1bf
Author: Maxim Petrusevich <>
Authored: Tue Apr 18 12:16:34 2017 +0300
Committer: Maxim Petrusevich <>
Committed: Tue Apr 18 12:16:34 2017 +0300

 docs/doc/src/main/resources/RELEASE-NOTES.txt   |  1 +
 docs/doc/src/main/resources/UPGRADE.txt         | 25 +++++++-------------
 .../getting-started/src/docbkx/java-classes.xml | 11 +++++++--
 3 files changed, 19 insertions(+), 18 deletions(-)
diff --git a/docs/doc/src/main/resources/RELEASE-NOTES.txt b/docs/doc/src/main/resources/RELEASE-NOTES.txt
index 31b50af..d3b8b07 100644
--- a/docs/doc/src/main/resources/RELEASE-NOTES.txt
+++ b/docs/doc/src/main/resources/RELEASE-NOTES.txt
@@ -31,6 +31,7 @@ CAY-2272 ColumnSelect: methods to manually control DISTINCT clause
 CAY-2274 Modeler: Validate case when dependent PK is marked as “generated”
 CAY-2277 Create ClientRuntime with ClientRuntimeBuilder just like ServerRuntime
 CAY-2278 Extract cayenne-postcommit module from cayenne-lifecycle
+CAY-2280 Switch from commons-logging to slf4j
 Bug Fixes:
diff --git a/docs/doc/src/main/resources/UPGRADE.txt b/docs/doc/src/main/resources/UPGRADE.txt
index 997285a..0418ccb 100644
--- a/docs/doc/src/main/resources/UPGRADE.txt
+++ b/docs/doc/src/main/resources/UPGRADE.txt
@@ -7,22 +7,15 @@ IMPORTANT: be sure to read all notes for the intermediate releases between
-* Per CAY-2280 org.apache.commons.logging.Log logger was replaced to org.slf4j.Logger logger.
-        To change the logger to SLF4J need:
-        - Replace logger dependencies in pom.xml files from commons-logging to slf4j-api
(if pom.xml contains slf4j-api
-        in test scope - replace test scope to compile scope);
-        - In classes that import org.apache.commons.logging.Log, replace org.apache.commons.logging.Log
-        org.slf4j.Logger (and org.apache.commons.logging.LogFactory to org.slf4j.LoggerFactory
if exist);
-        - Replace all fields type of Log to Logger (and LogFactory to LoggerFactory if exist,
and methods call from
-        LogFactory.getLog(...) to LoggerFactory.getLogger(...) if exist);
-        - Change interface in custom loggers (MavenLogger, AntLogger, ModelerLogger(if exist))
from Log to Logger, and
-         override standart methods;
-        - Delete file.
-        For go to a SLF4J without changing the source code need:
-        - Add to pom.xml files jcl-over-slf4j dependency;
-        - Exclude commons-logging dependencies from pom.xml.
+* Per CAY-2280 Cayenne migrated from commons-logging to SLF4J.
+      Here is options you have to upgrade your project accordingly:
+      1) Migrate your logging to SLF4J. Please see for documentation
+      inclusion into your project logging backend of you choice.
+      2) Other option is to use commons-logging over SLF4J and keep all logging compatible
with previous Cayenne versions.
+      In order to do so you need:
+      - remove commons-logging dependency if you have it
+      - add to your project slf4j-jcl dependency
 * Per CAY-2278 The org.apache.cayenne.lifecycle.audit package (with the exception of AuditableChild
annotation) and the
        org.apache.cayenne.lifecycle.changeset package where deprecated.
diff --git a/docs/docbook/getting-started/src/docbkx/java-classes.xml b/docs/docbook/getting-started/src/docbkx/java-classes.xml
index 848699f..d27631f 100644
--- a/docs/docbook/getting-started/src/docbkx/java-classes.xml
+++ b/docs/docbook/getting-started/src/docbkx/java-classes.xml
@@ -71,13 +71,20 @@
-            &lt;version>4.0.M5&lt;/version>
+            &lt;version><?eval ${project.version}?>&lt;/version>
+        &lt;/dependency>
+        &lt;dependency>
+            &lt;groupId>org.slf4j&lt;/groupId>
+            &lt;artifactId>slf4j-simple&lt;/artifactId>
+            &lt;version>1.7.25&lt;/version>
         <para>Your computer must be connected to the internet. Once you edit the <code>pom.xml</code>,
             will download the needed Cayenne jar file and add it to the project build path.
As a
-            result, all the errors should disappear.</para>
+            result, all the errors should disappear. In tutorial for console output we use
slf4j-simple logger
+            implementation. Due to use SLF4J logger in Apache Cayenne, you can use your custom
logger through bridges
+            (e.g log4j bridge, jcl bridge et. al.)</para>
                     <imagedata fileref="images/idea-generated-classes.png" scalefit="1"

View raw message