Changeset 7648 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Jun 22, 2006, 4:35:05 PM (20 years ago)

Author:

Paul Price

Message:

Adding psLibInit and psLibFinalize; adding PS_ALLOC_CHECK feature (implemented already).

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (2 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.412 2006-06-23 01:53:42 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.413 2006-06-23 02:35:05 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -280 +280 @@
 \subsection{Initialization}
 
-Before certain \code{psTime} functions can be employed, the user must
-call \code{psTimeInitialize}.
+Initialization of the library is necessary in the general case.
+\code{psLibInit} shall initialize those elements of the library that
+require initialization.  This includes loading the time configuration
+(through \code{psTimeInitialize}).  In addition, if the environment
+variable \code{PS_ALLOC_CHECK} (analagous to \code{MALLOC_CHECK_}
+under GNU libc 2.x), then a memory check (checking for all leaks, and
+corruption) shall be performed at exit, with any problems reported to
+the file specified by \code{PS_ALLOC_CHECK}.
+
+\code{psLibFinalize} shall free all memory used by psLib.
+
+\begin{prototype}
+void psLibInit(const char *timeConfig);
+void psLibFinalize(void);
+\end{prototype}
+
+
 
 \subsection{Memory Management}