From: Andrew Carlotti <andrew.carlotti@arm.com>
Date: Fri, 12 Aug 2022 13:36:22 +0000 (+0100)
Subject: Improve comment for tree_niter_desc.{control,bound,cmp}
X-Git-Tag: basepoints/gcc-14~5174
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=88ee126ee0401e293888e7d1b9219ad35eb130b5;p=thirdparty%2Fgcc.git

Improve comment for tree_niter_desc.{control,bound,cmp}

Fix typos and explain ERROR_MARK usage.

gcc/ChangeLog:

	* tree-ssa-loop.h: Improve comment
---

diff --git a/gcc/tree-ssa-loop.h b/gcc/tree-ssa-loop.h
index 415f461c37e..6c70f795d17 100644
--- a/gcc/tree-ssa-loop.h
+++ b/gcc/tree-ssa-loop.h
@@ -54,11 +54,11 @@ public:
   widest_int max;	/* The upper bound on the number of iterations of
 			   the loop.  */
 
-  /* The simplified shape of the exit condition.  The loop exits if
-     CONTROL CMP BOUND is false, where CMP is one of NE_EXPR,
-     LT_EXPR, or GT_EXPR, and step of CONTROL is positive if CMP is
-     LE_EXPR and negative if CMP is GE_EXPR.  This information is used
-     by loop unrolling.  */
+  /* The simplified shape of the exit condition.  This information is used by
+     loop unrolling.  If CMP is ERROR_MARK, then the loop cannot be unrolled.
+     Otherwise, the loop exits if CONTROL CMP BOUND is false, where CMP is one
+     of NE_EXPR, LT_EXPR, or GT_EXPR, and CONTROL.STEP is positive if CMP is
+     LT_EXPR and negative if CMP is GT_EXPR.  */
   affine_iv control;
   tree bound;
   enum tree_code cmp;