From: Gary V. Vaughan <gary@gnu.org>
Date: Sun, 20 Apr 2008 21:35:46 +0000 (-0400)
Subject: Fix misleading lt_dlopenadvise documentation.
X-Git-Tag: v2.2.4~22
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=314d795eab720baf4416cc703b27a9059fea509d;p=thirdparty%2Flibtool.git

Fix misleading lt_dlopenadvise documentation.

* doc/libtool.texi (lt_dlopenadvise): The last parameter is of
type lt_dladvise, not lt_dladvise*.
(my_dlopenext): Correct the example too.
* NEWS: Updated.
Reported by Gary Kumfert <kumfert@llnl.gov>
---

diff --git a/ChangeLog b/ChangeLog
index d3609a96c..8d2e5c33c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2008-04-20  Gary V. Vaughan  <gary@gnu.org>
+
+	Fix misleading lt_dlopenadvise documentation.
+	* doc/libtool.texi (lt_dlopenadvise): The last parameter is of
+	type lt_dladvise, not lt_dladvise*.
+	(my_dlopenext): Correct the example too.
+	* NEWS: Updated.
+	Reported by Gary Kumfert <kumfert@llnl.gov>
+
 2008-04-19  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
 	Fix testsuite cleanup warnings on AIX with NFS.
diff --git a/NEWS b/NEWS
index 420e53bba..300a57faa 100644
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,12 @@
 NEWS - list of user-visible changes between releases of GNU Libtool
 
+New in 2.2.4: 2008-??-??: CVS version 2.2.3a, Libtool team:
+
+* Bug fixes:
+
+  - The documentation for lt_dlopenadvise showed the wrong type for
+    the lt_dladvise parameter.
+
 New in 2.2.2: 2008-04-01: CVS version 2.2.1a, Libtool team:
 
 * New features:
diff --git a/doc/libtool.texi b/doc/libtool.texi
index febbd118d..5a2bd551b 100644
--- a/doc/libtool.texi
+++ b/doc/libtool.texi
@@ -3685,11 +3685,15 @@ to be able to @code{dlopen} such libraries as well as libtool modules
 transparently.
 @end deftypefun
 
-@deftypefun lt_dlhandle lt_dlopenadvise (const char *@var{filename}, @w{lt_dladvise *@var{advise}})
+@deftypefun lt_dlhandle lt_dlopenadvise (const char *@var{filename}, @w{lt_dladvise @var{advise}})
 The same as @code{lt_dlopen}, except that it also requires an additional
 argument which may contain additional hints to the underlying system
 module loader.  The @var{advise} parameter is opaque and can only be
 accessed with the functions documented below.
+
+Note that this function does not change the content of @var{advise}, so
+unlike the other calls in this @sc{api} takes a direct @code{lt_dladvise}
+type, and not a pointer to the same.
 @end deftypefun
 
 @deftypefun int lt_dladvise_init (lt_dladvise *@var{advise})
@@ -3727,7 +3731,7 @@ my_dlopenext (const char *filename)
   lt_dladvise advise;
 
   if (!lt_dladvise_init (&advise) && !lt_dladvise_ext (&advise))
-    handle = lt_dlopenadvise (filename, &advise);
+    handle = lt_dlopenadvise (filename, advise);
 
   lt_dladvise_destroy (&advise);