diff mbox

tree-ssa documetation fix

Message ID CAObPJ3OD-gFfnzX2zA0J9mJD90Vie-BfX7+LKwEiy+MMiKfUcA@mail.gmail.com
State New
Headers show

Commit Message

Martin Liška Oct. 29, 2013, 9:53 a.m. UTC 
Hello,
  I've noticed that some part of documentation is obsolete and this
patch adds documentation for new functions that replace old macros.

Thanks,
Martin

Comments

Jeff Law Oct. 29, 2013, 5:45 p.m. UTC | #1 
On 10/29/13 03:53, Martin Liška wrote:
> Hello,
>    I've noticed that some part of documentation is obsolete and this
> patch adds documentation for new functions that replace old macros.
[ ... ]
Thanks.  Installed on the trunk.

jeff
diff mbox

Patch

diff --git a/ChangeLog b/ChangeLog
index 1c50b9b..d64fbcf 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@ 
+2013-10-29	Martin Liska <marxin.liska@gmail.com>
+
+	* doc/tree-ssa.texi: Newly added functions that replace old macros
+	are documented.
+
 2013-10-21  Cong Hou  <congh@google.com>
 
 	* MAINTAINERS (Write After Approval): Add myself.
diff --git a/gcc/doc/tree-ssa.texi b/gcc/doc/tree-ssa.texi
index aaf741b..93f596d 100644
--- a/gcc/doc/tree-ssa.texi
+++ b/gcc/doc/tree-ssa.texi
@@ -526,31 +526,29 @@  the result of ``merging'' @code{a_1}, @code{a_2} and @code{a_3}.
 Hence, PHI nodes mean ``one of these operands.  I don't know
 which''.
 
-The following macros can be used to examine PHI nodes
+The following functions can be used to examine PHI nodes
 
-@defmac PHI_RESULT (@var{phi})
+@defun gimple_phi_result (@var{phi})
 Returns the @code{SSA_NAME} created by PHI node @var{phi} (i.e.,
 @var{phi}'s LHS)@.
-@end defmac
+@end defun
 
-@defmac PHI_NUM_ARGS (@var{phi})
+@defun gimple_phi_num_args (@var{phi})
 Returns the number of arguments in @var{phi}.  This number is exactly
 the number of incoming edges to the basic block holding @var{phi}@.
-@end defmac
+@end defun
 
-@defmac PHI_ARG_ELT (@var{phi}, @var{i})
-Returns a tuple representing the @var{i}th argument of @var{phi}@.
-Each element of this tuple contains an @code{SSA_NAME} @var{var} and
-the incoming edge through which @var{var} flows.
-@end defmac
+@defun gimple_phi_arg (@var{phi}, @var{i})
+Returns @var{i}th argument of @var{phi}@.
+@end defun
 
-@defmac PHI_ARG_EDGE (@var{phi}, @var{i})
+@defun gimple_phi_arg_edge (@var{phi}, @var{i})
 Returns the incoming edge for the @var{i}th argument of @var{phi}.
-@end defmac
+@end defun
 
-@defmac PHI_ARG_DEF (@var{phi}, @var{i})
+@defun gimple_phi_arg_def (@var{phi}, @var{i})
 Returns the @code{SSA_NAME} for the @var{i}th argument of @var{phi}.
-@end defmac
+@end defun
 
 
 @subsection Preserving the SSA form