Skip to content

Commit 03482e5

Browse files
committed
Java/C#: Update the internal documentation.
1 parent 917cf7b commit 03482e5

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

csharp/ql/lib/semmle/code/csharp/dataflow/ExternalFlow.qll

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,15 @@
7373
* sources "remote" indicates a default remote flow source, and for summaries
7474
* "taint" indicates a default additional taint step and "value" indicates a
7575
* globally applicable value-preserving step.
76-
* 9. The `provenance` column is a tag to indicate the origin of the summary.
77-
* There are two supported values: "generated" and "manual". "generated" means that
78-
* the model has been emitted by the model generator tool and "manual" means
79-
* that the model has been written by hand. This information is used in a heuristic
80-
* for dataflow analysis to determine, if a model or source code should be used for
81-
* determining flow.
76+
* 9. The `provenance` column is a tag to indicate the origin and verification of a model.
77+
* The format is {origin}-{verification} or just "manual" where the origin describes
78+
* the origin of the model and verification describes how the model has been verified.
79+
* Some examples are:
80+
* - "df-generated": The model has been generated by the model generator tool.
81+
* - "df-manual": The model has been generated by the model generator and verified by a human.
82+
* - "manual": The model has been written by hand.
83+
* This information is used in a heuristic for dataflow analysis to determine, if a
84+
* model or source code should be used for determining flow.
8285
*/
8386

8487
import csharp

java/ql/lib/semmle/code/java/dataflow/ExternalFlow.qll

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,15 @@
6666
* sources "remote" indicates a default remote flow source, and for summaries
6767
* "taint" indicates a default additional taint step and "value" indicates a
6868
* globally applicable value-preserving step.
69-
* 9. The `provenance` column is a tag to indicate the origin of the summary.
70-
* The supported values are: "manual", "generated" and "ai-generated". "manual"
71-
* means that the model has been written by hand, "generated" means that
72-
* the model has been emitted by the model generator tool and
73-
* "ai-generated" means that the model has been AI generated (ATM project).
69+
* 9. The `provenance` column is a tag to indicate the origin and verification of a model.
70+
* The format is {origin}-{verification} or just "manual" where the origin describes
71+
* the origin of the model and verification describes how the model has been verified.
72+
* Some examples are:
73+
* - "df-generated": The model has been generated by the model generator tool.
74+
* - "df-manual": The model has been generated by the model generator and verified by a human.
75+
* - "manual": The model has been written by hand.
76+
* This information is used in a heuristic for dataflow analysis to determine, if a
77+
* model or source code should be used for determining flow.
7478
*/
7579

7680
import java

0 commit comments

Comments
 (0)