Skip to content

Commit 4585c8c

Browse files
committed
(Multiple languages) Clarify defn of barriers
1 parent d1d6b52 commit 4585c8c

6 files changed

+10
-10
lines changed

docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ These predicates are defined in the configuration:
170170

171171
- ``isSource`` - defines where data may flow from.
172172
- ``isSink`` - defines where data may flow to.
173-
- ``isBarrier`` - optionally, restricts the data flow.
174-
- ``isAdditionalFlowStep`` - optionally, adds additional flow steps.
173+
- ``isBarrier`` - optional, defines where data flow is blocked.
174+
- ``isAdditionalFlowStep`` - optional, adds additional flow steps.
175175

176176
The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``:
177177

docs/codeql/codeql-language-guides/analyzing-data-flow-in-go.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ These predicates are defined in the configuration:
188188

189189
- ``isSource`` - defines where data may flow from.
190190
- ``isSink`` - defines where data may flow to.
191-
- ``isBarrier`` - optional, restricts the data flow.
191+
- ``isBarrier`` - optional, defines where data flow is blocked.
192192
- ``isAdditionalFlowStep`` - optional, adds additional flow steps.
193193

194194
The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``:

docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ These predicates are defined in the configuration:
196196

197197
- ``isSource`` - defines where data may flow from.
198198
- ``isSink`` - defines where data may flow to.
199-
- ``isBarrier`` - optional, restricts the data flow.
199+
- ``isBarrier`` - optional, defines where data flow is blocked.
200200
- ``isAdditionalFlowStep`` - optional, adds additional flow steps.
201201

202202
The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``:

docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,8 +228,8 @@ These predicates are defined in the configuration:
228228

229229
- ``isSource`` - defines where data may flow from.
230230
- ``isSink`` - defines where data may flow to.
231-
- ``isBarrier`` - optionally, restricts the data flow.
232-
- ``isAdditionalFlowStep`` - optionally, adds additional flow steps.
231+
- ``isBarrier`` - optional, defines where data flow is blocked.
232+
- ``isAdditionalFlowStep`` - optional, adds additional flow steps.
233233

234234
The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``:
235235

docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -248,8 +248,8 @@ These predicates are defined in the configuration:
248248

249249
- ``isSource`` - defines where data may flow from.
250250
- ``isSink`` - defines where data may flow to.
251-
- ``isBarrier`` - optionally, restricts the data flow.
252-
- ``isAdditionalFlowStep`` - optionally, adds additional flow steps.
251+
- ``isBarrier`` - optional, defines where data flow is blocked.
252+
- ``isAdditionalFlowStep`` - optional, adds additional flow steps.
253253

254254
The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``:
255255

docs/codeql/codeql-language-guides/analyzing-data-flow-in-swift.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,8 @@ These predicates are defined in the configuration:
185185

186186
- ``isSource`` - defines where data may flow from.
187187
- ``isSink`` - defines where data may flow to.
188-
- ``isBarrier`` - optionally, restricts the data flow.
189-
- ``isAdditionalFlowStep`` - optionally, adds additional flow steps.
188+
- ``isBarrier`` - optional, defines where data flow is blocked.
189+
- ``isAdditionalFlowStep`` - optional, adds additional flow steps.
190190

191191
The last line (``module MyDataFlow = ...``) instantiates the parameterized module for data flow analysis by passing the configuration to the parameterized module. Data flow analysis can then be performed using ``MyDataFlow::flow(DataFlow::Node source, DataFlow::Node sink)``:
192192

0 commit comments

Comments
 (0)