Document 'utc' parameter

This commit is contained in:
Andrew M. Kuchling 2008-06-05 23:33:54 +00:00
parent 8456f64ce2
commit 6dd8ccab2c
1 changed files with 7 additions and 3 deletions

View File

@ -1645,7 +1645,7 @@ The :class:`TimedRotatingFileHandler` class, located in the
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 @@ timed intervals.
*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 @@ timed intervals.
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.