Skip to content

Commit 99026a6

Browse files
committed
Improve wording of isAdditionalFlow/TaintStep qldoc
1 parent f480ab9 commit 99026a6

File tree

47 files changed

+188
-188
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+188
-188
lines changed

cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ abstract class Configuration extends string {
112112
predicate isBarrierGuard(BarrierGuard guard, FlowState state) { none() }
113113

114114
/**
115-
* Holds if the additional flow step from `node1` to `node2` must be taken
116-
* into account in the analysis.
115+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
116+
* in addition to the normal dataflow steps.
117117
*/
118118
predicate isAdditionalFlowStep(Node node1, Node node2) { none() }
119119

120120
/**
121-
* Holds if the additional flow step from `node1` to `node2` must be taken
122-
* into account in the analysis. This step is only applicable in `state1` and
121+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
122+
* in addition to the normal dataflow steps. This step is only applicable in `state1` and
123123
* updates the flow state to `state2`.
124124
*/
125125
predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {

cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl2.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ abstract class Configuration extends string {
112112
predicate isBarrierGuard(BarrierGuard guard, FlowState state) { none() }
113113

114114
/**
115-
* Holds if the additional flow step from `node1` to `node2` must be taken
116-
* into account in the analysis.
115+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
116+
* in addition to the normal dataflow steps.
117117
*/
118118
predicate isAdditionalFlowStep(Node node1, Node node2) { none() }
119119

120120
/**
121-
* Holds if the additional flow step from `node1` to `node2` must be taken
122-
* into account in the analysis. This step is only applicable in `state1` and
121+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
122+
* in addition to the normal dataflow steps. This step is only applicable in `state1` and
123123
* updates the flow state to `state2`.
124124
*/
125125
predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {

cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl3.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ abstract class Configuration extends string {
112112
predicate isBarrierGuard(BarrierGuard guard, FlowState state) { none() }
113113

114114
/**
115-
* Holds if the additional flow step from `node1` to `node2` must be taken
116-
* into account in the analysis.
115+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
116+
* in addition to the normal dataflow steps.
117117
*/
118118
predicate isAdditionalFlowStep(Node node1, Node node2) { none() }
119119

120120
/**
121-
* Holds if the additional flow step from `node1` to `node2` must be taken
122-
* into account in the analysis. This step is only applicable in `state1` and
121+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
122+
* in addition to the normal dataflow steps. This step is only applicable in `state1` and
123123
* updates the flow state to `state2`.
124124
*/
125125
predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {

cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl4.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ abstract class Configuration extends string {
112112
predicate isBarrierGuard(BarrierGuard guard, FlowState state) { none() }
113113

114114
/**
115-
* Holds if the additional flow step from `node1` to `node2` must be taken
116-
* into account in the analysis.
115+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
116+
* in addition to the normal dataflow steps.
117117
*/
118118
predicate isAdditionalFlowStep(Node node1, Node node2) { none() }
119119

120120
/**
121-
* Holds if the additional flow step from `node1` to `node2` must be taken
122-
* into account in the analysis. This step is only applicable in `state1` and
121+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
122+
* in addition to the normal dataflow steps. This step is only applicable in `state1` and
123123
* updates the flow state to `state2`.
124124
*/
125125
predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {

cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImplLocal.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ abstract class Configuration extends string {
112112
predicate isBarrierGuard(BarrierGuard guard, FlowState state) { none() }
113113

114114
/**
115-
* Holds if the additional flow step from `node1` to `node2` must be taken
116-
* into account in the analysis.
115+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
116+
* in addition to the normal dataflow steps.
117117
*/
118118
predicate isAdditionalFlowStep(Node node1, Node node2) { none() }
119119

120120
/**
121-
* Holds if the additional flow step from `node1` to `node2` must be taken
122-
* into account in the analysis. This step is only applicable in `state1` and
121+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
122+
* in addition to the normal dataflow steps. This step is only applicable in `state1` and
123123
* updates the flow state to `state2`.
124124
*/
125125
predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {

cpp/ql/lib/semmle/code/cpp/dataflow/internal/tainttracking1/TaintTrackingImpl.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ abstract class Configuration extends DataFlow::Configuration {
154154
}
155155

156156
/**
157-
* Holds if the additional taint propagation step from `node1` to `node2`
158-
* must be taken into account in the analysis.
157+
* Holds if the analysis should assume that taint may flow from `node1` to `node2`
158+
* in addition to the normal dataflow and taint steps.
159159
*/
160160
predicate isAdditionalTaintStep(DataFlow::Node node1, DataFlow::Node node2) { none() }
161161

@@ -165,8 +165,8 @@ abstract class Configuration extends DataFlow::Configuration {
165165
}
166166

167167
/**
168-
* Holds if the additional taint propagation step from `node1` to `node2`
169-
* must be taken into account in the analysis. This step is only applicable
168+
* Holds if the analysis should assume that taint may flow from `node1` to `node2`
169+
* in addition to the normal dataflow and taint steps. This step is only applicable
170170
* in `state1` and updates the flow state to `state2`.
171171
*/
172172
predicate isAdditionalTaintStep(

cpp/ql/lib/semmle/code/cpp/dataflow/internal/tainttracking2/TaintTrackingImpl.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ abstract class Configuration extends DataFlow::Configuration {
154154
}
155155

156156
/**
157-
* Holds if the additional taint propagation step from `node1` to `node2`
158-
* must be taken into account in the analysis.
157+
* Holds if the analysis should assume that taint may flow from `node1` to `node2`
158+
* in addition to the normal dataflow and taint steps.
159159
*/
160160
predicate isAdditionalTaintStep(DataFlow::Node node1, DataFlow::Node node2) { none() }
161161

@@ -165,8 +165,8 @@ abstract class Configuration extends DataFlow::Configuration {
165165
}
166166

167167
/**
168-
* Holds if the additional taint propagation step from `node1` to `node2`
169-
* must be taken into account in the analysis. This step is only applicable
168+
* Holds if the analysis should assume that taint may flow from `node1` to `node2`
169+
* in addition to the normal dataflow and taint steps. This step is only applicable
170170
* in `state1` and updates the flow state to `state2`.
171171
*/
172172
predicate isAdditionalTaintStep(

cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ abstract class Configuration extends string {
112112
predicate isBarrierGuard(BarrierGuard guard, FlowState state) { none() }
113113

114114
/**
115-
* Holds if the additional flow step from `node1` to `node2` must be taken
116-
* into account in the analysis.
115+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
116+
* in addition to the normal dataflow steps.
117117
*/
118118
predicate isAdditionalFlowStep(Node node1, Node node2) { none() }
119119

120120
/**
121-
* Holds if the additional flow step from `node1` to `node2` must be taken
122-
* into account in the analysis. This step is only applicable in `state1` and
121+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
122+
* in addition to the normal dataflow steps. This step is only applicable in `state1` and
123123
* updates the flow state to `state2`.
124124
*/
125125
predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {

cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl2.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ abstract class Configuration extends string {
112112
predicate isBarrierGuard(BarrierGuard guard, FlowState state) { none() }
113113

114114
/**
115-
* Holds if the additional flow step from `node1` to `node2` must be taken
116-
* into account in the analysis.
115+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
116+
* in addition to the normal dataflow steps.
117117
*/
118118
predicate isAdditionalFlowStep(Node node1, Node node2) { none() }
119119

120120
/**
121-
* Holds if the additional flow step from `node1` to `node2` must be taken
122-
* into account in the analysis. This step is only applicable in `state1` and
121+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
122+
* in addition to the normal dataflow steps. This step is only applicable in `state1` and
123123
* updates the flow state to `state2`.
124124
*/
125125
predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {

cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl3.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ abstract class Configuration extends string {
112112
predicate isBarrierGuard(BarrierGuard guard, FlowState state) { none() }
113113

114114
/**
115-
* Holds if the additional flow step from `node1` to `node2` must be taken
116-
* into account in the analysis.
115+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
116+
* in addition to the normal dataflow steps.
117117
*/
118118
predicate isAdditionalFlowStep(Node node1, Node node2) { none() }
119119

120120
/**
121-
* Holds if the additional flow step from `node1` to `node2` must be taken
122-
* into account in the analysis. This step is only applicable in `state1` and
121+
* Holds if the analysis should assume that data may flow from `node1` to `node2`
122+
* in addition to the normal dataflow steps. This step is only applicable in `state1` and
123123
* updates the flow state to `state2`.
124124
*/
125125
predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {

0 commit comments

Comments
 (0)