Skip to content

Commit ff37cfe

Browse files
committed
Issue #23305: clarified RotatingFileHandler documentation.
1 parent 5abca70 commit ff37cfe

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

Doc/library/logging.handlers.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -269,15 +269,16 @@ module, supports rotation of disk log files.
269269
You can use the *maxBytes* and *backupCount* values to allow the file to
270270
:dfn:`rollover` at a predetermined size. When the size is about to be exceeded,
271271
the file is closed and a new file is silently opened for output. Rollover occurs
272-
whenever the current log file is nearly *maxBytes* in length; if *maxBytes* is
273-
zero, rollover never occurs. If *backupCount* is non-zero, the system will save
274-
old log files by appending the extensions '.1', '.2' etc., to the filename. For
275-
example, with a *backupCount* of 5 and a base file name of :file:`app.log`, you
276-
would get :file:`app.log`, :file:`app.log.1`, :file:`app.log.2`, up to
277-
:file:`app.log.5`. The file being written to is always :file:`app.log`. When
278-
this file is filled, it is closed and renamed to :file:`app.log.1`, and if files
279-
:file:`app.log.1`, :file:`app.log.2`, etc. exist, then they are renamed to
280-
:file:`app.log.2`, :file:`app.log.3` etc. respectively.
272+
whenever the current log file is nearly *maxBytes* in length; if either of
273+
*maxBytes* or *backupCount* is zero, rollover never occurs. If *backupCount*
274+
is non-zero, the system will save old log files by appending the extensions
275+
'.1', '.2' etc., to the filename. For example, with a *backupCount* of 5 and
276+
a base file name of :file:`app.log`, you would get :file:`app.log`,
277+
:file:`app.log.1`, :file:`app.log.2`, up to :file:`app.log.5`. The file being
278+
written to is always :file:`app.log`. When this file is filled, it is closed
279+
and renamed to :file:`app.log.1`, and if files :file:`app.log.1`,
280+
:file:`app.log.2`, etc. exist, then they are renamed to :file:`app.log.2`,
281+
:file:`app.log.3` etc. respectively.
281282

282283

283284
.. method:: doRollover()

0 commit comments

Comments
 (0)