Add a comment briefly explaining partial symbols

Based on an explanation by tromey on IRC.

gdb/ChangeLog:

2019-08-05  Christian Biesinger  <cbiesinger@google.com>

	* objfiles.h (objfile): Add a comment describing partial symbols.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 0d324a56cfb02c2425077750c229af5c4fea54e1..da1d636a244a1d84672936885ea6ae3f45d09b37 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,7 @@
+2019-08-05  Christian Biesinger  <cbiesinger@google.com>
+
+       * objfiles.h (objfile): Add a comment describing partial symbols.
+
 2019-08-05  Tom Tromey  <tromey@adacore.com>
 
        * compile/compile.c (_initialize_compile): Use _(), not N_().

diff --git a/gdb/objfiles.h b/gdb/objfiles.h
index a0c106be3d4aa4c058f9a17eed3091f373d2903d..239aba2c2a1fb6cdd3735e024305e8c16199e992 100644 (file)
--- a/gdb/objfiles.h
+++ b/gdb/objfiles.h
@@ -382,7 +382,13 @@ private:
    2.  Additional symbol files added by the add-symbol-file command,
    3.  Shared library objfiles, added by ADD_SOLIB,  4.  symbol files
    for modules that were loaded when GDB attached to a remote system
-   (see remote-vx.c).  */
+   (see remote-vx.c).
+
+   GDB typically reads symbols twice -- first an initial scan which just
+   reads "partial symbols"; these are partial information for the
+   static/global symbols in a symbol file.  When later looking up symbols,
+   objfile->sf->qf->lookup_symbol is used to check if we only have a partial
+   symbol and if so, read and expand the full compunit.  */
 
 struct objfile
 {