symtab.h (lookup_global_symbol): Improve function comment.

gdb/ChangeLog:

	* symtab.h (lookup_global_symbol): Improve function comment.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 42ecfc4b5f6e8efc56d00bca68eea517607ab8f5..f75a5ba76e7e2cd09106c659d4029e2cebfac234 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,7 @@
+2014-11-06  Doug Evans  <xdje42@gmail.com>
+
+       * symtab.h (lookup_global_symbol): Improve function comment.
+
 2014-11-06  Doug Evans  <xdje42@gmail.com>
 
        * symtab.c (lookup_global_symbol): Renamed from lookup_symbol_global.

diff --git a/gdb/symtab.h b/gdb/symtab.h
index c967c62e53efff92745a520eb779679bf8025685..9b3ea803291caac580b899d6281f7abaae21c9cc 100644 (file)
--- a/gdb/symtab.h
+++ b/gdb/symtab.h
@@ -1104,6 +1104,14 @@ extern struct symbol *lookup_static_symbol (const char *name,
                                            const domain_enum domain);
 
 /* Lookup a symbol in all files' global blocks.
+
+   If BLOCK is non-NULL then it is used for two things:
+   1) If a target-specific lookup routine for libraries exists, then use the
+      routine for the objfile of BLOCK, and
+   2) The objfile of BLOCK is used to assist in determining the search order
+      if the target requires it.
+      See gdbarch_iterate_over_objfiles_in_search_order.
+
    Upon success sets BLOCK_FOUND and fixes up the symbol's section
    if necessary.  */