hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14731 from owen-mc/docs/dataflow-never-skip

Browse Source 
Docs: document dataflow `neverSkip` (and expand section on hidden nodes)
This commit is contained in:
Owen Mansel-Chan
2023-11-09 12:08:00 +00:00
committed by GitHub
parent 4cc75c5bd6 38766c497a
commit e16647fc87
1 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/ql-libraries/dataflow/dataflow.md
View File

@@ -618,12 +618,31 @@ impact on performance for large databases.
### Hidden nodes
Certain synthetic nodes can be hidden to exclude them from occurring in path
explanations. This is done through the following predicate:
Certain synthetic nodes are hidden by default to prevent them from occurring in
path explanations. Which nodes are included in this is determined by the
following predicate:
```ql
predicate nodeIsHidden(Node n)
```
To include these nodes in path explanations, add the following to a
configuration:
```ql
predicate includeHiddenNodes() { any() }
```
### Show more nodes in path explanations
Path explanations skip over most nodes and only show the important nodes in a
path. To ensure that particular nodes are shown, define the following predicate
in a configuration:
```ql
predicate neverSkip(Node n)
```
### Unreachable nodes
Consider: