hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-02 12:15:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Highlight that Configuration is not DataFlow::Configuration

Browse Source 
I made that mistake when just reading it over (DOH). I think that calling it
MyConfiguration makes it a bit more clear that this is a configuration class you
wrote yourself :D
This commit is contained in:
Rasmus Wriedt Larsen
2021-03-17 15:55:58 +01:00
parent d95b295e52
commit 4f63584179
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/codeql/writing-codeql-queries/creating-path-queries.rst
View File

@@ -58,7 +58,7 @@ You should use the following template:
import DataFlow::PathGraph
...
from Configuration config, DataFlow::PathNode source, DataFlow::PathNode sink
from MyConfiguration config, DataFlow::PathNode source, DataFlow::PathNode sink
where config.hasFlowPath(source, sink)
select sink.getNode(), source, sink, "<message>"
@@ -66,7 +66,7 @@ Where:
- ``DataFlow::Pathgraph`` is the path graph module you need to import from the standard CodeQL libraries.
- ``source`` and ``sink`` are nodes on the `path graph <https://en.wikipedia.org/wiki/Path_graph>`__, and ``DataFlow::PathNode`` is their type.
- ``Configuration`` is a class containing the predicates which define how data may flow between the ``source`` and the ``sink``.
- ``MyConfiguration`` is a class containing the predicates which define how data may flow between the ``source`` and the ``sink``.
The following sections describe the main requirements for a valid path query.