Fix __builtin_expect_with_probability documentation
authorJonathan Wakely <jwakely@redhat.com>
Tue, 30 Oct 2018 12:17:27 +0000 (12:17 +0000)
committerJonathan Wakely <redi@gcc.gnu.org>
Tue, 30 Oct 2018 12:17:27 +0000 (12:17 +0000)
* doc/extend.texi: Fix prototype and description of
__builtin_expect_with_probability.

From-SVN: r265622

gcc/ChangeLog
gcc/doc/extend.texi

index 1dcec6a..af5e154 100644 (file)
@@ -1,3 +1,8 @@
+2018-10-30  Jonathan Wakely  <jwakely@redhat.com>
+
+       * doc/extend.texi: Fix prototype and description of
+       __builtin_expect_with_probability.
+
 2018-10-30  Michael Ploujnikov  <michael.ploujnikov@oracle.com>
 
        * cgraph.h (clone_function_name_1): Replaced by new
index 8772f3a..4dbb2da 100644 (file)
@@ -12025,12 +12025,12 @@ when testing pointer or floating-point values.
 @end deftypefn
 
 @deftypefn {Built-in Function} long __builtin_expect_with_probability
-(long @var{exp}, long @var{c}, long @var{probability})
+(long @var{exp}, long @var{c}, double @var{probability})
 
-The built-in has same semantics as @code{__builtin_expect},
-but user can provide expected probability (in percent) for value of @var{exp}.
-Last argument @var{probability} is of float type and valid values
-are in inclusive range 0.0f and 1.0f.
+This function has the same semantics as @code{__builtin_expect},
+but the caller provides the expected probability that @var{exp} == @var{c}.
+The last argument, @var{probability}, is a floating-point value in the
+range 0.0 to 1.0, inclusive.
 @end deftypefn
 
 @deftypefn {Built-in Function} void __builtin_trap (void)