]> granicus.if.org Git - python/commitdiff
Document 'utc' parameter
authorAndrew M. Kuchling <amk@amk.ca>
Thu, 5 Jun 2008 23:33:54 +0000 (23:33 +0000)
committerAndrew M. Kuchling <amk@amk.ca>
Thu, 5 Jun 2008 23:33:54 +0000 (23:33 +0000)
Doc/library/logging.rst

index 1f7c59b06af9cc7b202ba843d20eaff9279fba25..b1eeda720cbe00ab15a2f5aa3d741dfe082d290b 100644 (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.