* tree.h (TYPE_STUB_DECL): Add documentation.

From-SVN: r39340

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index 9eb4d2c9f7bab9ea1c10f84eaa93a02e09c90da0..cc4af5fce47f5bdca7959f055620466efaa8979f 100644 (file)
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,4 +1,8 @@
-2000-11-29  Laurynas Biveinis  <lauras@softhome.net>
+2001-11-29  Tim Josling  <tej@melbpc.org.au>
+
+       * tree.h (TYPE_STUB_DECL): Add documentation.
+
+2001-11-29  Laurynas Biveinis  <lauras@softhome.net>
 
        * sdbout.c (sdbout_one_type): Skip types with indeterminate size.
        (sdbout_field_types): Likwise.  Fix use of host_integerp.

diff --git a/gcc/tree.h b/gcc/tree.h
index 1ff74410a94fa71ff315bbcc7b3faa5f5fed0f83..f9da7c9a5b149b8a70ef7deff4ae9d76fed05436 100644 (file)
--- a/gcc/tree.h
+++ b/gcc/tree.h
@@ -939,6 +939,13 @@ struct tree_block
 #define TYPE_ALIGN_UNIT(NODE) \
   (TYPE_ALIGN (NODE) / BITS_PER_UNIT)
 
+/* If your language allows you to declare types, and you want debug info
+   for them, then you need to generate corresponding TYPE_DECL nodes.
+   These "stub" TYPE_DECL nodes have no name, and simply point at the
+   type node.  You then set the TYPE_STUB_DECL field of the type node
+   to point back at the TYPE_DECL node.  This allows the debug routines
+   to know that the two nodes represent the same type, so that we only
+   get one debug info record for them. */
 #define TYPE_STUB_DECL(NODE) (TREE_CHAIN (NODE))
 
 /* In a RECORD_TYPE, UNION_TYPE or QUAL_UNION_TYPE, it means the type