LOGCXX-493: LoggingEvent::timeStamp and ::getStartTime were documented to 
provide milliseconds, but are ultimately set using apr_time_now and that 
provides microseconds. Additionally, RelativeTimeDateFormat was documented to 
provide seconds, but is based on getStartTime with microseconds and 
ttcclayout.h documents that RelativeTimeDateFormat provides milliseconds as 
well. So implementation of RelativeTimeDateFormat is the same like for 
RelativeTimePatternConverter, which documents to provide milliseconds, too.

This is backported from master to be able to generate and publish a current 
version of apidocs.

(cherry picked from commit 4cf6ae6f16a307f242216b1c669c2d9213b82712)


Project: http://git-wip-us.apache.org/repos/asf/logging-log4cxx/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4cxx/commit/d7bfafe2
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4cxx/tree/d7bfafe2
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4cxx/diff/d7bfafe2

Branch: refs/heads/Branch_refs/tags/latest_stable
Commit: d7bfafe2e2414abcf0a3143fcda492c8dcdb2a25
Parents: 576e626
Author: Thorsten Schöning <[email protected]>
Authored: Mon Oct 16 11:26:04 2017 +0200
Committer: Thorsten Schöning <[email protected]>
Committed: Mon Oct 16 11:42:52 2017 +0200

----------------------------------------------------------------------
 src/changes/changes.xml                                   | 1 +
 src/main/include/log4cxx/helpers/relativetimedateformat.h | 2 +-
 src/main/include/log4cxx/spi/loggingevent.h               | 4 ++--
 3 files changed, 4 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4cxx/blob/d7bfafe2/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 24f327a..cee1d34 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -228,6 +228,7 @@
                        <action issue="LOGCXX-257" 
type="fix">ServerSocket::accept hangs on Unix</action>
                        <action issue="LOGCXX-258" type="fix">unable to build 
from make dist package due to missing doxygen file</action>
                        <action issue="LOGCXX-259" type="fix">Several appenders 
fail to compile in Visual Studio 2008</action>
+                       <action issue="LOGCXX-493" type="fix">Wrong usage of 
milli- vs. micro- and non- vs. milliseconds in some docs.</action>
                </release>
                <release version="0.9.7" date="2004-05-10">
                        <action type="fix">Fixed examples source code in the 
"Short introduction to log4cxx".</action>

http://git-wip-us.apache.org/repos/asf/logging-log4cxx/blob/d7bfafe2/src/main/include/log4cxx/helpers/relativetimedateformat.h
----------------------------------------------------------------------
diff --git a/src/main/include/log4cxx/helpers/relativetimedateformat.h 
b/src/main/include/log4cxx/helpers/relativetimedateformat.h
index b60d62f..85daade 100644
--- a/src/main/include/log4cxx/helpers/relativetimedateformat.h
+++ b/src/main/include/log4cxx/helpers/relativetimedateformat.h
@@ -25,7 +25,7 @@ namespace log4cxx
         namespace helpers
         {
                 /**
-                Formats a date by printing the number of seconds
+                Formats a date by printing the number of milliseconds
                 elapsed since the start of the application. This is the fastest
                 printing DateFormat in the package.
                 */

http://git-wip-us.apache.org/repos/asf/logging-log4cxx/blob/d7bfafe2/src/main/include/log4cxx/spi/loggingevent.h
----------------------------------------------------------------------
diff --git a/src/main/include/log4cxx/spi/loggingevent.h 
b/src/main/include/log4cxx/spi/loggingevent.h
index 25f5c0d..0147ecf 100644
--- a/src/main/include/log4cxx/spi/loggingevent.h
+++ b/src/main/include/log4cxx/spi/loggingevent.h
@@ -100,7 +100,7 @@ namespace log4cxx
                                 { return message; }
 
                         /**Returns the time when the application started,
-                        in seconds elapsed since 01.01.1970.
+                        in microseconds elapsed since 01.01.1970.
                         */
                         static log4cxx_time_t getStartTime();
 
@@ -226,7 +226,7 @@ namespace log4cxx
                         LogString message;
 
 
-                        /** The number of milliseconds elapsed from 1/1/1970 
until logging event
+                        /** The number of microseconds elapsed from 01.01.1970 
until logging event
                          was created. */
                         log4cxx_time_t timeStamp;
 

Reply via email to