gdb/objfiles: add comment explaining when obj_section::the_bfd_section is nullptr

Change-Id: Iae17492f468efba7b76463a6ff8526171e412040
Reviewed-By: Tom de Vries <tdevries@suse.de>

diff --git a/gdb/objfiles.h b/gdb/objfiles.h
index bce85576e6c7fe910a063caaeac8f42a83172f3f..da9d2f3f9389afd111cfe958ea61f7960783f380 100644 (file)
--- a/gdb/objfiles.h
+++ b/gdb/objfiles.h
@@ -395,7 +395,9 @@ struct obj_section
     return addr >= this->addr () && addr < endaddr ();
   }
 
-  /* BFD section pointer */
+  /* BFD section pointer.  This is nullptr if the corresponding BFD section is
+     not allocatable (!SEC_ALLOC), in which case this obj_section can be
+     considered NULL / empty.  */
   struct bfd_section *the_bfd_section;
 
   /* Objfile this section is part of.  */