summaryrefslogtreecommitdiffstats
path: root/spec/rtems/basedefs/if/predict-true.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/basedefs/if/predict-true.yml')
-rw-r--r--spec/rtems/basedefs/if/predict-true.yml12
1 files changed, 7 insertions, 5 deletions
diff --git a/spec/rtems/basedefs/if/predict-true.yml b/spec/rtems/basedefs/if/predict-true.yml
index 83afbb07..74151329 100644
--- a/spec/rtems/basedefs/if/predict-true.yml
+++ b/spec/rtems/basedefs/if/predict-true.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the value of the specified integral expression and tells the compiler
- that the predicted value is true (1).
+ Evaluates the integral expression and tells the compiler that the predicted
+ value is true (1).
copyrights:
- Copyright (C) 2018 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -9,7 +9,7 @@ definition:
( _exp )
variants:
- definition: |
- ${/compiler/if/builtin-expect:/name}( ( _exp ), 1 )
+ ${/compiler/if/builtin-expect:/name}( ( _exp ), 0 )
enabled-by:
- defined(${/compiler/if/gnuc:/name})
description: null
@@ -25,10 +25,12 @@ name: RTEMS_PREDICT_TRUE
notes: null
params:
- description: |
- is the expression.
+ is the integral expression.
dir: null
name: _exp
return:
- return: The value of the expression.
+ return: |
+ Returns the value of the integral expression and tells the compiler that
+ the predicted value is true (1).
return-values: []
type: interface