From: Doug Evans <xdje42@gmail.com>
Date: Fri, 7 Nov 2014 07:51:21 +0000 (-0800)
Subject: symtab.h (lookup_global_symbol): Improve function comment.
X-Git-Tag: hjl/linux/release/2.25.51.0.1~3^2~44^2~7
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=67be31e5aae5075a99068e752b138a0934bde83c;p=thirdparty%2Fbinutils-gdb.git

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 42ecfc4b5f6..f75a5ba76e7 100644
--- 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 c967c62e53e..9b3ea803291 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.  */