From: Diego Novillo <dnovillo@google.com>
Date: Fri, 9 Jan 2009 21:11:25 +0000 (-0500)
Subject: gimple.h (struct gimple_statement_base): Document the restrictions on its use.
X-Git-Tag: releases/gcc-4.4.0~949
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e0e10d3a2842b224fd9a69aa7a1b60f4343e24f9;p=thirdparty%2Fgcc.git

gimple.h (struct gimple_statement_base): Document the restrictions on its use.


	* gimple.h (struct gimple_statement_base)<uid>: Document
	the restrictions on its use.
	(gimple_uid): Tidy.
	(gimple_set_uid): Tidy.

From-SVN: r143233
---

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index 0f0331a5bf04..2fade47ba200 100644
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,10 @@
+2009-01-09  Diego Novillo  <dnovillo@google.com>
+
+	* gimple.h (struct gimple_statement_base)<uid>: Document
+	the restrictions on its use.
+	(gimple_uid): Tidy.
+	(gimple_set_uid): Tidy.
+
 2009-01-09  Jakub Jelinek  <jakub@redhat.com>
 
 	* config/i386/i386.c (ix86_expand_movmem, ix86_expand_setmem): Add
diff --git a/gcc/gimple.h b/gcc/gimple.h
index 8f8e49b61b39..7760e247aa9e 100644
--- a/gcc/gimple.h
+++ b/gcc/gimple.h
@@ -297,7 +297,9 @@ struct gimple_statement_base GTY(())
      in there.  */
   unsigned int subcode		: 16;
 
-  /* UID of this statement.  */
+  /* UID of this statement.  This is used by passes that want to
+     assign IDs to statements.  It must be assigned and used by each
+     pass.  By default it should be assumed to contain garbage.  */
   unsigned uid;
 
   /* [ WORD 2 ]
@@ -1204,7 +1206,7 @@ gimple_plf (gimple stmt, enum plf_mask plf)
 }
 
 
-/* Set the uid of statement  */
+/* Set the UID of statement.  */
 
 static inline void
 gimple_set_uid (gimple g, unsigned uid)
@@ -1213,7 +1215,7 @@ gimple_set_uid (gimple g, unsigned uid)
 }
 
 
-/* Return the uid of statement  */
+/* Return the UID of statement.  */
 
 static inline unsigned
 gimple_uid (const_gimple g)