C++: Address review comments

jketema · jketema · commit b9200c92d552 · 2023-02-13T11:14:48.000+01:00
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/new/DataFlow.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/new/DataFlow.qll
@@ -8,8 +8,8 @@
  * results than the AST-based library in most scenarios.
  *
  * Unless configured otherwise, _flow_ means that the exact value of
- * the source may reach the sink. We do not track flow across pointer
- * dereferences or array indexing.
+ * the source may reach the sink. To track flow where the exact value
+ * may not be preserved, import `semmle.code.cpp.dataflow.new.TaintTracking`.
  *
  * To use global (interprocedural) data flow, extend the class
  * `DataFlow::Configuration` as documented on that class. To use local
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/new/DataFlow2.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/new/DataFlow2.qll
@@ -6,7 +6,7 @@
  * `DataFlow2::Configuration`, a `DataFlow3::Configuration`, or a
  * `DataFlow4::Configuration`.
  *
- * See `semmle.code.cpp.ir.dataflow.DataFlow` for the full documentation.
+ * See `semmle.code.cpp.dataflow.new.DataFlow` for the full documentation.
  */
 
 import cpp
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/new/DataFlow3.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/new/DataFlow3.qll
@@ -6,7 +6,7 @@
  * `DataFlow2::Configuration`, a `DataFlow3::Configuration`, or a
  * `DataFlow4::Configuration`.
  *
- * See `semmle.code.cpp.ir.dataflow.DataFlow` for the full documentation.
+ * See `semmle.code.cpp.dataflow.new.DataFlow` for the full documentation.
  */
 
 import cpp
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/new/DataFlow4.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/new/DataFlow4.qll
@@ -6,7 +6,7 @@
  * `DataFlow2::Configuration`, a `DataFlow3::Configuration`, or a
  * `DataFlow4::Configuration`.
  *
- * See `semmle.code.cpp.ir.dataflow.DataFlow` for the full documentation.
+ * See `semmle.code.cpp.dataflow.new.DataFlow` for the full documentation.
  */
 
 import cpp
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/new/TaintTracking2.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/new/TaintTracking2.qll
@@ -8,7 +8,7 @@
  * `TaintTracking::Configuration` class extends `DataFlow::Configuration`, and
  * `TaintTracking2::Configuration` extends `DataFlow2::Configuration`.
  *
- * See `semmle.code.cpp.ir.dataflow.TaintTracking` for the full documentation.
+ * See `semmle.code.cpp.dataflow.new.TaintTracking` for the full documentation.
  */
 
 /**
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/new/TaintTracking3.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/new/TaintTracking3.qll
@@ -8,7 +8,7 @@
  * `TaintTracking::Configuration` class extends `DataFlow::Configuration`, and
  * `TaintTracking2::Configuration` extends `DataFlow2::Configuration`.
  *
- * See `semmle.code.cpp.ir.dataflow.TaintTracking` for the full documentation.
+ * See `semmle.code.cpp.dataflow.new.TaintTracking` for the full documentation.
  */
 
 /**
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/DataFlow.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/DataFlow.qll
@@ -8,8 +8,8 @@
  * results than the AST-based library in most scenarios.
  *
  * Unless configured otherwise, _flow_ means that the exact value of
- * the source may reach the sink. We do not track flow across pointer
- * dereferences or array indexing.
+ * the source may reach the sink. To track flow where the exact value
+ * may not be preserved, import `semmle.code.cpp.ir.dataflow.TaintTracking`.
  *
  * To use global (interprocedural) data flow, extend the class
  * `DataFlow::Configuration` as documented on that class. To use local

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,8 @@`
`8`	`8`	`* results than the AST-based library in most scenarios.`
`9`	`9`	`*`
`10`	`10`	`* Unless configured otherwise, _flow_ means that the exact value of`
`11`		`- * the source may reach the sink. We do not track flow across pointer`
`12`		`- * dereferences or array indexing.`
	`11`	`+ * the source may reach the sink. To track flow where the exact value`
	`12`	+ * may not be preserved, import `semmle.code.cpp.dataflow.new.TaintTracking`.
`13`	`13`	`*`
`14`	`14`	`* To use global (interprocedural) data flow, extend the class`
`15`	`15`	* `DataFlow::Configuration` as documented on that class. To use local
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	* `DataFlow2::Configuration`, a `DataFlow3::Configuration`, or a
`7`	`7`	* `DataFlow4::Configuration`.
`8`	`8`	`*`
`9`		- * See `semmle.code.cpp.ir.dataflow.DataFlow` for the full documentation.
	`9`	+ * See `semmle.code.cpp.dataflow.new.DataFlow` for the full documentation.
`10`	`10`	`*/`
`11`	`11`
`12`	`12`	`import cpp`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	* `TaintTracking::Configuration` class extends `DataFlow::Configuration`, and
`9`	`9`	* `TaintTracking2::Configuration` extends `DataFlow2::Configuration`.
`10`	`10`	`*`
`11`		- * See `semmle.code.cpp.ir.dataflow.TaintTracking` for the full documentation.
	`11`	+ * See `semmle.code.cpp.dataflow.new.TaintTracking` for the full documentation.
`12`	`12`	`*/`
`13`	`13`
`14`	`14`	`/**`