[Python-checkins] python/dist/src/Doc/lib liblogging.tex,1.5,1.6

Tue, 28 Jan 2003 14:02:39 -0800

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv23762

Modified Files:
	liblogging.tex 
Log Message:
Various minor markup adjustments.

Index: liblogging.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liblogging.tex,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** liblogging.tex	25 Jan 2003 21:46:53 -0000	1.5
--- liblogging.tex	28 Jan 2003 22:02:35 -0000	1.6
***************
*** 9,13 ****
  \sectionauthor{Vinay Sajip}{vinay_sajip@red-dove.com}

! \modulesynopsis{Logging module for Python based on PEP 282.}

  \indexii{Errors}{logging}
--- 9,13 ----
  \sectionauthor{Vinay Sajip}{vinay_sajip@red-dove.com}

! \modulesynopsis{Logging module for Python based on \pep{282}.}

  \indexii{Errors}{logging}
***************
*** 91,95 ****

  \item \class{SysLogHandler} instances send error messages to a
! Unix syslog, possibly on a remote machine.

  \item \class{NTEventLogHandler} instances send error messages to a
--- 91,95 ----

  \item \class{SysLogHandler} instances send error messages to a
! \UNIX{} syslog daemon, possibly on a remote machine.

  \item \class{NTEventLogHandler} instances send error messages to a
***************
*** 101,105 ****

  \item \class{HTTPHandler} instances send error messages to an
! HTTP server using either GET or POST semantics.

  \end{enumerate}
--- 101,105 ----

  \item \class{HTTPHandler} instances send error messages to an
! HTTP server using either \samp{GET} or \samp{POST} semantics.

  \end{enumerate}
***************
*** 228,231 ****
--- 228,239 ----
  \end{funcdesc}

+ 
+ \begin{seealso}
+   \seepep{282}{A Logging System}
+          {The proposal which described this feature for inclusion in
+           the Python standard library.}
+ \end{seealso}
+ 
+ 
  \subsection{Logger Objects}

***************
*** 343,350 ****
  \subsection{Handler Objects}

! Handlers have the following attributes and methods. Note that a Handler is
! never instantiated directly; this class acts as a base for more useful
! subclasses. However, the \method{__init__()} in subclasses needs to call
! \method{Handler.__init__()}.

  \begin{methoddesc}{__init__}{level=\constant{ALL}}
--- 351,358 ----
  \subsection{Handler Objects}

! Handlers have the following attributes and methods. Note that
! \class{Handler} is never instantiated directly; this class acts as a
! base for more useful subclasses. However, the \method{__init__()}
! method in subclasses needs to call \method{Handler.__init__()}.

  \begin{methoddesc}{__init__}{level=\constant{ALL}}
***************
*** 458,462 ****

  The \class{FileHandler} class sends logging output to a disk file.
! It delegates the output functionality from \class{StreamHandler}.

  \begin{classdesc}{FileHandler}{filename\optional{, mode}}
--- 466,470 ----

  The \class{FileHandler} class sends logging output to a disk file.
! It inherits the output functionality from \class{StreamHandler}.

  \begin{classdesc}{FileHandler}{filename\optional{, mode}}
***************
*** 483,487 ****
  Returns a new instance of the \class{RotatingFileHandler} class. The
  specified file is opened and used as the stream for logging. If
! \var{mode} is not specified, \constant{"a"} is used. By default, the
  file grows indefinitely. You can use the \var{maxBytes} and
  \var{backupCount} values to allow the file to \dfn{rollover} at a
--- 491,495 ----
  Returns a new instance of the \class{RotatingFileHandler} class. The
  specified file is opened and used as the stream for logging. If
! \var{mode} is not specified, \code{'a'} is used. By default, the
  file grows indefinitely. You can use the \var{maxBytes} and
  \var{backupCount} values to allow the file to \dfn{rollover} at a
***************
*** 583,594 ****

  The \class{SysLogHandler} class supports sending logging messages to a
! remote or local Unix syslog.

  \begin{classdesc}{SysLogHandler}{\optional{address\optional{, facility}}}
  Returns a new instance of the \class{SysLogHandler} class intended to
! communicate with a remote Unix machine whose address is given by
! \var{address} in the form of a (host, port) tuple. If \var{address} is not
! specified, ('localhost', 514) is used. The address is used to open a UDP
! socket. If \var{facility} is not specified, \constant{LOG_USER} is used.
  \end{classdesc}

--- 591,603 ----

  The \class{SysLogHandler} class supports sending logging messages to a
! remote or local \UNIX{} syslog.

  \begin{classdesc}{SysLogHandler}{\optional{address\optional{, facility}}}
  Returns a new instance of the \class{SysLogHandler} class intended to
! communicate with a remote \UNIX{} machine whose address is given by
! \var{address} in the form of a \code{(\var{host}, \var{port})}
! tuple.  If \var{address} is not specified, \code{('localhost', 514)} is
! used.  The address is used to open a UDP socket.  If \var{facility} is
! not specified, \constant{LOG_USER} is used.
  \end{classdesc}

***************
*** 758,767 ****

  The \class{HTTPHandler} class supports sending logging messages to a
! Web server, using either GET or POST semantics.

  \begin{classdesc}{HTTPHandler}{host, url\optional{, method}}
  Returns a new instance of the \class{HTTPHandler} class. The
  instance is initialized with a host address, url and HTTP method.
! If no \var{method} is specified, GET is used.
  \end{classdesc}

--- 767,776 ----

  The \class{HTTPHandler} class supports sending logging messages to a
! Web server, using either \samp{GET} or \samp{POST} semantics.

  \begin{classdesc}{HTTPHandler}{host, url\optional{, method}}
  Returns a new instance of the \class{HTTPHandler} class. The
  instance is initialized with a host address, url and HTTP method.
! If no \var{method} is specified, \samp{GET} is used.
  \end{classdesc}