diff mbox

[9/9] Improve function comment for lookup_global_symbol.

Message ID m3oasyje9j.fsf@sspiff.org
State New, archived
Headers

Commit Message

Doug Evans Oct. 27, 2014, 5:03 a.m. UTC 
  Hi.

The BLOCK argument to lookup_global_symbol is not documented.

2014-10-26  Doug Evans  <xdje42@gmail.com>

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

Patch

diff --git a/gdb/symtab.h b/gdb/symtab.h
index c967c62..9b3ea80 100644
--- 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.  */