Fix comment for 'gdb_dlopen'

The 'gdb_dlopen' function doesn't return NULL if the shlib load
fails; it actually throws an error.  This patch updates the comment
to reflect this.

gdbsupport/ChangeLog:
2020-02-28  Sergio Durigan Junior  <sergiodj@redhat.com>

	* gdb-dlfcn.h (gdb_dlopen): Update comment.

diff --git a/gdbsupport/ChangeLog b/gdbsupport/ChangeLog
index d01966ed1d0e574ba9f58e16406b30f7869139db..88f2b821b565cad579bc934a517ec4f16ff7c279 100644 (file)
--- a/gdbsupport/ChangeLog
+++ b/gdbsupport/ChangeLog
@@ -1,3 +1,7 @@
+2020-02-28  Sergio Durigan Junior  <sergiodj@redhat.com>
+
+       * gdb-dlfcn.h (gdb_dlopen): Update comment.
+
 2020-02-19  Andrew Burgess  <andrew.burgess@embecosm.com>
 
        * configure: Regenerate.

diff --git a/gdbsupport/gdb-dlfcn.h b/gdbsupport/gdb-dlfcn.h
index 258cfebbc3e2e21e0ee86c676d34da2c4af5f8f3..9e72a53dc0a22f11fde6cf302af80dbe5ab3d5cb 100644 (file)
--- a/gdbsupport/gdb-dlfcn.h
+++ b/gdbsupport/gdb-dlfcn.h
@@ -32,8 +32,8 @@ struct dlclose_deleter
 typedef std::unique_ptr<void, dlclose_deleter> gdb_dlhandle_up;
 
 /* Load the dynamic library file named FILENAME, and return a handle
-   for that dynamic library.  Return NULL if the loading fails for any
-   reason.  */
+   for that dynamic library.  Throw an error if the loading fails for
+   any reason.  */
 
 gdb_dlhandle_up gdb_dlopen (const char *filename);