[Python-checkins] python/dist/src/Doc/lib libcgitb.tex,1.3,1.4

montanaro@users.sourceforge.net montanaro@users.sourceforge.net
Tue, 17 Jun 2003 05:58:33 -0700


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

Modified Files:
	libcgitb.tex 
Log Message:
SF Patch 569574 - enhancements to cgitb for plain text display


Index: libcgitb.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcgitb.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** libcgitb.tex	20 Dec 2001 17:13:09 -0000	1.3
--- libcgitb.tex	17 Jun 2003 12:58:31 -0000	1.4
***************
*** 13,19 ****
  \index{tracebacks!in CGI scripts}
  
! The \module{cgitb} module provides a special exception handler for CGI
! scripts.  After this module is activated, if an uncaught exception occurs,
! a detailed, formatted report will be sent to the Web browser.  The report
  includes a traceback showing excerpts of the source code for each level,
  as well as the values of the arguments and local variables to currently
--- 13,22 ----
  \index{tracebacks!in CGI scripts}
  
! The \module{cgitb} module provides a special exception handler for Python
! scripts.  (It's name is a bit misleading.  It was originally designed to
! display extensive traceback information in HTML for CGI scripts.  It was
! later generalized to also display this information in plain text.)  After
! this module is activated, if an uncaught exception occurs, a detailed,
! formatted report will be displayed.  The report
  includes a traceback showing excerpts of the source code for each level,
  as well as the values of the arguments and local variables to currently
***************
*** 33,37 ****
  
  \begin{funcdesc}{enable}{\optional{display\optional{, logdir\optional{,
!                          context}}}}
    This function causes the \module{cgitb} module to take over the
    interpreter's default handling for exceptions by setting the
--- 36,40 ----
  
  \begin{funcdesc}{enable}{\optional{display\optional{, logdir\optional{,
!                          context\optional{, format}}}}}
    This function causes the \module{cgitb} module to take over the
    interpreter's default handling for exceptions by setting the
***************
*** 47,50 ****
--- 50,56 ----
    context to display around the current line of source code in the
    traceback; this defaults to \code{5}.
+   If the optional argument \var{format} is \code{"html"}, the output is
+   formatted as HTML.  Any other value forces plain text output.  The default
+   value is \code{"html"}.
  \end{funcdesc}