From 4585c8caf29b73bd9ac3096801aa052ffeb2601e Mon Sep 17 00:00:00 2001 From: Owen Mansel-Chan Date: Fri, 17 Jan 2025 14:17:55 +0000 Subject: [PATCH] (Multiple languages) Clarify defn of barriers --- .../codeql-language-guides/analyzing-data-flow-in-csharp.rst | 4 ++-- .../codeql-language-guides/analyzing-data-flow-in-go.rst | 2 +- .../codeql-language-guides/analyzing-data-flow-in-java.rst | 2 +- .../codeql-language-guides/analyzing-data-flow-in-python.rst | 4 ++-- .../codeql-language-guides/analyzing-data-flow-in-ruby.rst | 4 ++-- .../codeql-language-guides/analyzing-data-flow-in-swift.rst | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst index 6657778ec4a..0369fec6ffb 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst @@ -170,8 +170,8 @@ These predicates are defined in the configuration: - ``isSource`` - defines where data may flow from. - ``isSink`` - defines where data may flow to. -- ``isBarrier`` - optionally, restricts the data flow. -- ``isAdditionalFlowStep`` - optionally, adds additional flow steps. +- ``isBarrier`` - optional, defines where data flow is blocked. +- ``isAdditionalFlowStep`` - optional, adds additional flow steps. The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``: diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-go.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-go.rst index e709b541201..684d05802c3 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-go.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-go.rst @@ -188,7 +188,7 @@ These predicates are defined in the configuration: - ``isSource`` - defines where data may flow from. - ``isSink`` - defines where data may flow to. -- ``isBarrier`` - optional, restricts the data flow. +- ``isBarrier`` - optional, defines where data flow is blocked. - ``isAdditionalFlowStep`` - optional, adds additional flow steps. The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``: diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst index 9f8af1642e9..d08b9e2103b 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst @@ -196,7 +196,7 @@ These predicates are defined in the configuration: - ``isSource`` - defines where data may flow from. - ``isSink`` - defines where data may flow to. -- ``isBarrier`` - optional, restricts the data flow. +- ``isBarrier`` - optional, defines where data flow is blocked. - ``isAdditionalFlowStep`` - optional, adds additional flow steps. The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``: diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst index 8adbfb09a5c..8a50f9bfa07 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst @@ -228,8 +228,8 @@ These predicates are defined in the configuration: - ``isSource`` - defines where data may flow from. - ``isSink`` - defines where data may flow to. -- ``isBarrier`` - optionally, restricts the data flow. -- ``isAdditionalFlowStep`` - optionally, adds additional flow steps. +- ``isBarrier`` - optional, defines where data flow is blocked. +- ``isAdditionalFlowStep`` - optional, adds additional flow steps. The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``: diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst index 44428000875..dfd2486fda7 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst @@ -248,8 +248,8 @@ These predicates are defined in the configuration: - ``isSource`` - defines where data may flow from. - ``isSink`` - defines where data may flow to. -- ``isBarrier`` - optionally, restricts the data flow. -- ``isAdditionalFlowStep`` - optionally, adds additional flow steps. +- ``isBarrier`` - optional, defines where data flow is blocked. +- ``isAdditionalFlowStep`` - optional, adds additional flow steps. The data flow analysis is performed using the predicate ``flow(DataFlow::Node source, DataFlow::Node sink)``: diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-swift.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-swift.rst index 76cb8da18a1..544b5755d22 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-swift.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-swift.rst @@ -185,8 +185,8 @@ These predicates are defined in the configuration: - ``isSource`` - defines where data may flow from. - ``isSink`` - defines where data may flow to. -- ``isBarrier`` - optionally, restricts the data flow. -- ``isAdditionalFlowStep`` - optionally, adds additional flow steps. +- ``isBarrier`` - optional, defines where data flow is blocked. +- ``isAdditionalFlowStep`` - optional, adds additional flow steps. 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)``: