[Python-checkins] CVS: python/dist/src/Doc/lib libgc.tex,1.1,1.2

[Vladimir Marangozov]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory slayer.i.sourceforge.net:/tmp/cvs-serv25095/Doc/lib

Modified Files:
	libgc.tex 
Log Message:
Neil Schemenauer: GC enable(), disable(), isenabled() interface.

Small stylistic changes by VM:
- is_enabled() -> isenabled()
- static ... Py_<func> -> static ... gc_<func>



Index: libgc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libgc.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** libgc.tex	2000/07/12 04:22:53	1.1
--- libgc.tex	2000/08/06 22:45:31	1.2
***************
*** 6,20 ****
  \sectionauthor{Neil Schemenauer}{nascheme@enme.ucalgary.ca}
  
! This module provides an interface to the optional garbage collector.
! It provides the ability to disable the collector, tune the collection
  frequency, and set debugging options.  It also provides access to
! unreachable objects that the collector found but cannot free.  Since
! the collector supplements the reference counting already used in
! Python, you can disable the collector if you are sure your program
! does not create reference cycles.  The collector can be disabled by
! calling \code{gc.set_threshold(0)}.  To debug a leaking program call
  \code{gc.set_debug(gc.DEBUG_LEAK)}.
  
  The \module{gc} module provides the following functions:
  
  \begin{funcdesc}{collect}{}
--- 6,32 ----
  \sectionauthor{Neil Schemenauer}{nascheme@enme.ucalgary.ca}
  
! This module provides an interface to the optional garbage collector.  It
! provides the ability to disable the collector, tune the collection
  frequency, and set debugging options.  It also provides access to
! unreachable objects that the collector found but cannot free.  Since the
! collector supplements the reference counting already used in Python, you
! can disable the collector if you are sure your program does not create
! reference cycles.  Automatic collection can be disabled by calling
! \code{gc.disable()}.  To debug a leaking program call
  \code{gc.set_debug(gc.DEBUG_LEAK)}.
  
  The \module{gc} module provides the following functions:
+ 
+ \begin{funcdesc}{enable}{}
+ Enable automatic garbage collection.
+ \end{funcdesc}
+ 
+ \begin{funcdesc}{disable}{}
+ Disable automatic garbage collection.
+ \end{funcdesc}
+ 
+ \begin{funcdesc}{isenabled}{}
+ Returns true if automatic collection is enabled.
+ \end{funcdesc}
  
  \begin{funcdesc}{collect}{}