Skip to content

Commit 8ee87fd

Browse files
committed
C++: Make TaintTracking2 QLDoc more like DataFlow2
1 parent 26c81ea commit 8ee87fd

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

cpp/ql/src/semmle/code/cpp/dataflow/TaintTracking2.qll

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
/**
2-
* Provides classes for performing local (intra-procedural) and
3-
* global (inter-procedural) taint-tracking analyses.
2+
* Provides a `TaintTracking2` module, which is a copy of the `TaintTracking`
3+
* module. Use this class when data-flow configurations or taint-tracking
4+
* configurations must depend on each other. Two classes extending
5+
* `DataFlow::Configuration` should never depend on each other, but one of them
6+
* should instead depend on a `DataFlow2::Configuration`, a
7+
* `DataFlow3::Configuration`, or a `DataFlow4::Configuration`. The
8+
* `TaintTracking::Configuration` class extends `DataFlow::Configuration`, and
9+
* `TaintTracking2::Configuration` extends `DataFlow2::Configuration`.
410
*
5-
* We define _taint propagation_ informally to mean that a substantial part of
6-
* the information from the source is preserved at the sink. For example, taint
7-
* propagates from `x` to `x + 100`, but it does not propagate from `x` to `x >
8-
* 100` since we consider a single bit of information to be too little.
11+
* See `semmle.code.cpp.dataflow.TaintTracking` for the full documentation.
912
*/
1013
module TaintTracking2 {
1114
import semmle.code.cpp.dataflow.internal.tainttracking2.TaintTrackingImpl

0 commit comments

Comments
 (0)