Re: HEAD ltdl documentation patch

[Robert Boehne]

Robert Boehne wrote:
> 
> Hello,
> 
> As I've been working on the documetation for HEAD libtool with
> tag support, I've also found that the docs for the interface of
> libltdl were somewhat out of date.  As I'm not intimately familiar
> with libltdl I'd like someone to look this over before it's committed.
> 
> Robert
> 

Hello,

Gary found a problem with that patch, so here is a new one.

Robert


-- 
Robert Boehne             Software Engineer
Ricardo Software   Chicago Technical Center
TEL: (630)789-0003 x. 238
FAX: (630)789-0127
email:  address@hidden

ChangeLog entry:

2001-06-12  Robert Boehne  <address@hidden>

        * docs/libtool.texi: Updated the libltdl interface documentation
        to bring it up to date.


Index: doc/libtool.texi
===================================================================
RCS file: /cvsroot/libtool/libtool/doc/libtool.texi,v
retrieving revision 1.116
diff -u -r1.116 libtool.texi
--- doc/libtool.texi    2001/04/05 23:43:39     1.116
+++ doc/libtool.texi    2001/06/12 17:25:14
@@ -1683,7 +1683,7 @@
 @end defvar
 
 @defvar LDFLAGS
-The flags to be used by @code{ltconfig} when it links a program.  If
+The flags to be used by @code{libtool} when it links a program.  If
 this is not set, @code{AC_PROG_LIBTOOL} will not use any such flags.  It
 affects only the way @code{AC_PROG_LIBTOOL} runs tests, not the produced
 @code{libtool}.
@@ -2785,7 +2785,7 @@
 If the symbol cannot be found, @code{NULL} is returned.
 @end deftypefun
 
address@hidden {const char *}lt_dlerror (void)
address@hidden {const char *} lt_dlerror (void)
 Return a human readable string describing the most
 recent error that occurred from any of libltdl's functions.
 Return @code{NULL} if no errors have occurred since initialization
@@ -3153,11 +3153,11 @@
 @code{lt_dlloader} is a handle for module loader types.
 @end deftp
 
address@hidden {Type} lt_dlloader_data
address@hidden is used for specifying loader instance data.
address@hidden {Type} lt_user_data
address@hidden is used for specifying loader instance data.
 @end deftp
 
address@hidden {Type} {struct} lt_user_dlloader @address@hidden char 
address@hidden;} @w{lt_module_open address@hidden;address@hidden 
address@hidden;} @w{lt_find_sym address@hidden;} @w{lt_dlloader_exit 
address@hidden;} @w{lt_dlloader_data @var{dlloader_data};} @}
address@hidden {Type} {struct} lt_user_dlloader @address@hidden char 
address@hidden;} @w{lt_module_open address@hidden;} @w{lt_module_close 
address@hidden;} @w{lt_find_sym address@hidden;} @w{lt_dlloader_exit 
address@hidden;} @}
 If you want to define a new way to open dynamic modules, and have the
 @code{lt_dlopen} @sc{api} use it, you need to instantiate one of these
 structures and pass it to @code{lt_dlloader_add}.  You can pass whatever
@@ -3166,7 +3166,7 @@
 the function pointer fields.
 @end deftypefn
 
address@hidden {Type} lt_module lt_module_open (@w{lt_user_data 
@var{loader_data},} @w{const char address@hidden)
address@hidden {Type} lt_module lt_module_open (@w{const char address@hidden)
 The type of the loader function for an @code{lt_dlloader} module
 loader.  The value set in the dlloader_data field of the @code{struct
 lt_user_dlloader} structure will be passed into this function in the
@@ -3177,7 +3177,7 @@
 return @code{NULL}, and set the error message with @code{lt_dlseterror}.
 @end deftypefn
 
address@hidden {Type} int lt_module_close (@w{lt_dlloader_data 
@var{loader_data},} @w{lt_module @var{module}})
address@hidden {Type} int lt_module_close (@w{lt_user_data @var{loader_data},} 
@w{lt_module @var{module}})
 The type of the unloader function for a user defined module loader.
 Implementatation of such a function should attempt to release
 any resources tied up by the @var{module} module, and then unload it
@@ -3185,7 +3185,7 @@
 message with @code{lt_dlseterror} and return non-zero.
 @end deftypefn
 
address@hidden {Type} lt_ptr lt_find_sym (@w{lt_user_data @var{loader_data},} 
@w{lt_module @var{module},} @w{const char address@hidden)
address@hidden {Type} lt_ptr lt_find_sym (@w{lt_module @var{module},} @w{const 
char address@hidden)
 The type of the symbol lookup function for a user defined module loader.
 Implementation of such a function should return the address of the named
 @var{symbol} in the module @var{module}, or else set the error message