This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
[DOC PATCH] Document is_gimple_ip_invariant and is_gimple_ip_invariant_address
- From: Martin Jambor <mjambor at suse dot cz>
- To: GCC Patches <gcc-patches at gcc dot gnu dot org>
- Date: Fri, 19 Mar 2010 16:26:32 +0100
- Subject: [DOC PATCH] Document is_gimple_ip_invariant and is_gimple_ip_invariant_address
Hi,
for some reason, documenting these two functions was on one of my TODO
lists. So here it is. Tested with "make pdf," OK for trunk (now)?
Thanks,
Martin
2010-03-19 Martin Jambor <mjambor@suse.cz>
* doc/gimple.texi (Logical Operators): Describe is_gimple_ip_invariant
and is_gimple_ip_invariant_address.
Index: icln/gcc/doc/gimple.texi
===================================================================
--- icln.orig/gcc/doc/gimple.texi
+++ icln/gcc/doc/gimple.texi
@@ -679,8 +679,19 @@ the address of a function local variable
@end deftypefn
@deftypefn {GIMPLE function} is_gimple_min_invariant_address (tree t)
+Return true if t is an @code{ADDR_EXPR} that does not change once a
+function is running.
+@end deftypefn
+
+@deftypefn {GIMPLE function} is_gimple_ip_invariant (tree t)
+Return true if t is an interprocedural invariant. This means that t
+is a valid invariant in all functions (e.g. it can be an address of a
+global variable but not of a local one).
+@end deftypefn
+
+@deftypefn {GIMPLE function} is_gimple_ip_invariant_address (tree t)
Return true if t is an @code{ADDR_EXPR} that does not change once the
-program is running.
+program is running (and which is valid in all functions).
@end deftypefn