[Python-checkins] r63970 - python/trunk/Doc/library/logging.rst

Fri Jun 6 01:33:55 CEST 2008

Author: andrew.kuchling
Date: Fri Jun 6 01:33:54 2008
New Revision: 63970
Log:
Document 'utc' parameter
Modified:
 python/trunk/Doc/library/logging.rst
Modified: python/trunk/Doc/library/logging.rst
==============================================================================

--- python/trunk/Doc/library/logging.rst	(original)
+++ python/trunk/Doc/library/logging.rst	Fri Jun 6 01:33:54 2008
@@ -1645,7 +1645,7 @@
 timed intervals.
 
 
-.. class:: TimedRotatingFileHandler(filename [,when [,interval [,backupCount[, encoding[, delay]]]]])
+.. class:: TimedRotatingFileHandler(filename [,when [,interval [,backupCount[, encoding[, delay[, utc]]]]]])
 
 Returns a new instance of the :class:`TimedRotatingFileHandler` class. The
 specified file is opened and used as the stream for logging. On rotating it also
@@ -1653,7 +1653,7 @@
 *interval*.
 
 You can use the *when* to specify the type of *interval*. The list of possible
- values is, note that they are not case sensitive:
+ values is below. Note that they are not case sensitive. :
 
 +----------------+-----------------------+
 | Value | Type of interval |
@@ -1674,7 +1674,11 @@
 The system will save old log files by appending extensions to the filename.
 The extensions are date-and-time based, using the strftime format
 ``%Y-%m-%d_%H-%M-%S`` or a leading portion thereof, depending on the
- rollover interval. If *backupCount* is nonzero, at most *backupCount* files
+ rollover interval. 
+ If the 'utc' argument was true, times in UTC will be used; otherwise
+ local time is used.
+
+ If *backupCount* is nonzero, at most *backupCount* files
 will be kept, and if more would be created when rollover occurs, the oldest
 one is deleted. The deletion logic uses the interval to determine which
 files to delete, so changing the interval may leave old files lying around.
