From: Johannes Gijsbers <jlg@dds.nl>
Date: Sun, 7 Nov 2004 16:11:35 +0000 (+0000)
Subject: Patch #1061924: add documentation for BaseRotatingHandler and correct
X-Git-Tag: v2.4c1~73
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f164322fe8115abe0d20f087391e67843255f578;p=thirdparty%2FPython%2Fcpython.git

Patch #1061924: add documentation for BaseRotatingHandler and correct
reference to non-existent function 'setRollover()'.
---

diff --git a/Doc/lib/liblogging.tex b/Doc/lib/liblogging.tex
index 4725d58e32ad..869b5c17a6b9 100644
--- a/Doc/lib/liblogging.tex
+++ b/Doc/lib/liblogging.tex
@@ -77,6 +77,10 @@ streams (file-like objects).
 \item \class{FileHandler} instances send error messages to disk
 files.
 
+\item \class{BaseRotatingHandler} is tha base class for handlers that
+rotate log files at a certain point. It is not meant to be  instantiated
+directly. Instead, use RotatingFileHandler or TimedRotatingFileHandler.
+
 \item \class{RotatingFileHandler} instances send error messages to disk
 files, with support for maximum log file sizes and log file rotation.
 
@@ -890,8 +894,7 @@ Does a rollover, as described above.
 \end{methoddesc}
 
 \begin{methoddesc}{emit}{record}
-Outputs the record to the file, catering for rollover as described
-in \method{setRollover()}.
+Outputs the record to the file, catering for rollover as described previously.
 \end{methoddesc}
 
 \subsubsection{TimedRotatingFileHandler}