[LangRef] Correct return type llvm.test.set.loop.iterations.*
authorSam Parker <sam.parker@arm.com>
Mon, 19 Oct 2020 11:26:44 +0000 (12:26 +0100)
committerSam Parker <sam.parker@arm.com>
Mon, 19 Oct 2020 11:56:38 +0000 (12:56 +0100)
The langref description for llvm.test.set.loop.iterations.* were
missing the i1 return type.

Differential Revision: https://reviews.llvm.org/D89564

Patch by: Janek van Oirschot

llvm/docs/LangRef.rst

index 087cf1f..b36c544 100644 (file)
@@ -15474,8 +15474,8 @@ This is an overloaded intrinsic.
 
 ::
 
-      declare void @llvm.test.set.loop.iterations.i32(i32)
-      declare void @llvm.test.set.loop.iterations.i64(i64)
+      declare i1 @llvm.test.set.loop.iterations.i32(i32)
+      declare i1 @llvm.test.set.loop.iterations.i64(i64)
 
 Overview:
 """""""""
@@ -15499,6 +15499,7 @@ The '``llvm.test.set.loop.iterations.*``' intrinsics do not perform any
 arithmetic on their operand. It's a hint to the backend that can use this to
 set up the hardware-loop count with a target specific instruction, usually a
 move of this value to a special register or a hardware-loop instruction.
+The result is the conditional value of whether the given count is not zero.
 
 '``llvm.loop.decrement.reg.*``' Intrinsic
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^