[Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.117.2.1,1.117.2.2

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/api
In directory usw-pr-cvs1:/tmp/cvs-serv2803/api

Modified Files:
      Tag: release21-maint
	api.tex 
Log Message:

Add documentation for Py_Main() and PyThreadState_GetDict().


Index: api.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/api.tex,v
retrieving revision 1.117.2.1
retrieving revision 1.117.2.2
diff -C2 -r1.117.2.1 -r1.117.2.2
*** api.tex	2001/05/21 15:04:28	1.117.2.1
--- api.tex	2001/05/21 15:58:54	1.117.2.2
***************
*** 610,613 ****
--- 610,626 ----
  library that the Python runtime is using.
  
+ \begin{cfuncdesc}{int}{Py_Main}{int argc, char **argv}
+   The main program for the standard interpreter.  This is made
+   available for programs which embed Python.  The \var{argc} and
+   \var{argv} parameters should be prepared exactly as those which are
+   passed to a C program's \cfunction{main()} function.  It is
+   important to note that the argument list may be modified (but the
+   contents of the strings pointed to by the argument list are not).
+   The return value will be the integer passed to the
+   \function{sys.exit()} function, \code{1} if the interpreter exits
+   due to an exception, or \code{2} if the parameter list does not
+   represent a valid Python command line.
+ \end{cfuncdesc}
+ 
  \begin{cfuncdesc}{int}{PyRun_AnyFile}{FILE *fp, char *filename}
    If \var{fp} refers to a file associated with an interactive device
***************
*** 4574,4577 ****
--- 4587,4598 ----
  argument \var{tstate}, which may be \NULL{}.  The interpreter lock
  must be held.
+ \end{cfuncdesc}
+ 
+ \begin{cfuncdesc}{PyObject*}{PyThreadState_GetDict}{}
+ Return a dictionary in which extensions can store thread-specific
+ state information.  Each extension should use a unique key to use to
+ store state in the dictionary.  If this function returns \NULL, an
+ exception has been raised and the caller should allow it to
+ propogate.
  \end{cfuncdesc}