* tree-gimple.c (get_base_address): Update documentation.

From-SVN: r92134

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index de26071771aaa79a68bc6335a26e80b4b8600f0f..ac417a98f64f288c40bdf25a8fb9d24044bd76bf 100644 (file)
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,7 @@
+2004-12-14  Diego Novillo  <dnovillo@redhat.com>
+
+       * tree-gimple.c (get_base_address): Update documentation.
+
 2004-12-13  Richard Henderson  <rth@redhat.com>
 
        PR middle-end/17930

diff --git a/gcc/tree-gimple.c b/gcc/tree-gimple.c
index 935e5ae21a21de079c1f0ce9504346a5da726fdc..61d2ec74ace5cfc0d4745cd485ecee278ea08421 100644 (file)
--- a/gcc/tree-gimple.c
+++ b/gcc/tree-gimple.c
@@ -419,7 +419,14 @@ get_call_expr_in (tree t)
   return NULL_TREE;
 }
 
-/* Given a memory reference expression T, return its base address.  */
+/* Given a memory reference expression T, return its base address.
+   The base address of a memory reference expression is the main
+   object being referenced.  For instance, the base address for
+   'array[i].fld[j]' is 'array'.  You can think of this as stripping
+   away the offset part from a memory address.
+
+   This function calls handled_component_p to strip away all the inner
+   parts of the memory reference until it reaches the base object.  */
 
 tree
 get_base_address (tree t)