update documentation to new turn_into_tuple behaviour
authorMatthias Braun <matze@braunis.de>
Wed, 30 Jun 2010 12:47:58 +0000 (12:47 +0000)
committerMatthias Braun <matze@braunis.de>
Wed, 30 Jun 2010 12:47:58 +0000 (12:47 +0000)
[r27681]

include/libfirm/irgmod.h

index 0539d6a..0cf74e4 100644 (file)
@@ -36,8 +36,8 @@ FIRM_API void exchange(ir_node *old, ir_node *nw);
 /** Turns a node into a "useless" Tuple.
  *
  *  Turns a node into a "useless" Tuple.  The Tuple node just forms a tuple
- *  from several inputs.  The predecessors of the tuple have to be
- *  set by hand.  The block predecessor automatically remains the same.
+ *  from several inputs. All predecessors of the tuple are set to bad and
+ *  should be replaced if necssary. The block predecessor remains the same.
  *  This is useful if a node returning a tuple is removed, but the Projs
  *  extracting values from the tuple are not available.
  *