* rtlanal.c (note_stores): Improve documentation.

git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@125746 138bc75d-0d04-0410-961f-82ee72b054a4

1 files changed, 7 insertions, 4 deletions

diff --git a/gcc/rtlanal.c b/gcc/rtlanal.c
index 3a26d8f490e..3cdb76a16bd 100644
--- a/gcc/rtlanal.c
+++ b/gcc/rtlanal.c
@@ -1396,10 +1396,13 @@ reg_overlap_mentioned_p (rtx x, rtx in)
 }
 
 /* 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.  */