Skip to content

Commit 893cb59

Browse files
committed
SSA: Elaborate qldoc a bit.
1 parent 1d30103 commit 893cb59

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

shared/ssa/codeql/ssa/Ssa.qll

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1579,6 +1579,14 @@ module Make<LocationSig Location, InputSig<Location> Input> {
15791579
* Holds if this guard evaluating to `branch` controls the control-flow
15801580
* branch edge from `bb1` to `bb2`. That is, following the edge from
15811581
* `bb1` to `bb2` implies that this guard evaluated to `branch`.
1582+
*
1583+
* This predicate differs from `hasBranchEdge` in that it also covers
1584+
* indirect guards, such as:
1585+
* ```
1586+
* b = guard;
1587+
* ...
1588+
* if (b) { ... }
1589+
* ```
15821590
*/
15831591
predicate controlsBranchEdge(BasicBlock bb1, BasicBlock bb2, boolean branch);
15841592
}

0 commit comments

Comments
 (0)