* rtlanal.c (note_stores): Improve documentation.

From-SVN: r125746

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index f83983d98f19d7288dcdbcefd790bdf8b91238cf..be3b820705ccee41a3c0ed102cbaafe26c0567bf 100644 (file)
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,7 @@
+2007-06-15  Mark Mitchell  <mark@codesourcery.com>
+
+       * rtlanal.c (note_stores): Improve documentation.
+
 2007-06-15  Bernd Schmidt  <bernd.schmidt@analog.com>
 
        * config/bfin/elf.h (ASM_GENERATE_INTERNAL_LABEL,

diff --git a/gcc/rtlanal.c b/gcc/rtlanal.c
index 3a26d8f490ed1f7d75630778cf3ffd2005e39618..3cdb76a16bd40a2f082259bf84012098ea9de7cf 100644 (file)
--- a/gcc/rtlanal.c
+++ b/gcc/rtlanal.c
@@ -1396,10 +1396,13 @@ reg_overlap_mentioned_p (rtx x, rtx in)
 }
 \f
 /* Call FUN on each register or MEM that is stored into or clobbered by X.
-   (X would be the pattern of an insn).
-   FUN receives two arguments:
-     the REG, MEM, CC0 or PC being stored in or clobbered,
-     the SET or CLOBBER rtx that does the store.
+   (X would be the pattern of an insn).  DATA is an arbitrary pointer,
+   ignored by note_stores, but passed to FUN.
+
+   FUN receives three arguments:
+   1. the REG, MEM, CC0 or PC being stored in or clobbered,
+   2. the SET or CLOBBER rtx that does the store,
+   3. the pointer DATA provided to note_stores.
 
   If the item being stored in or clobbered is a SUBREG of a hard register,
   the SUBREG will be passed.  */