2002-10-23 Elena Zannoni <ezannoni@redhat.com>

	* symtab.h: Update comment.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 05d0fc9..2e2faeb 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,7 @@
+2002-10-23  Elena Zannoni  <ezannoni@redhat.com>
+
+       * symtab.h: Update comment.
+
 2002-10-23  Michael Snyder  <msnyder@redhat.com>
 
        * printcmd.c (address_info): Restore quotes in output.

diff --git a/gdb/symtab.h b/gdb/symtab.h
index 941a7f1..6c18ccb 100644 (file)
--- a/gdb/symtab.h
+++ b/gdb/symtab.h
@@ -126,6 +126,14 @@ struct general_symbol_info
 
 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
 
+/* Note that all the following SYMBOL_* macros are used with the
+   SYMBOL argument being either a partial symbol, a minimal symbol or
+   a full symbol.  All three types have a ginfo field.  In particular
+   the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_INIT_DEMANGLED_NAME,
+   SYMBOL_DEMANGLED_NAME macros cannot be entirely substituted by
+   functions, unless the callers are changed to pass in the ginfo
+   field only, instead of the SYMBOL parameter.  */
+
 #define SYMBOL_NAME(symbol)            (symbol)->ginfo.name
 #define SYMBOL_VALUE(symbol)           (symbol)->ginfo.value.ivalue
 #define SYMBOL_VALUE_ADDRESS(symbol)   (symbol)->ginfo.value.address