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

Updates for review comments

Browse Source
This commit is contained in:
Felicity Chapman
2023-09-15 09:27:27 +01:00
parent a4f3e5e0bb
commit 6b90ce0d80
2 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/codeql/codeql-for-visual-studio-code/using-the-codeql-model-editor.rst
View File

@@ -65,10 +65,12 @@ The models are stored in your workspace at ``.github/codeql/extensions/<codeql-m
The models are stored in a series of YAML data extension files, one for each external API. For example:
- ``.github/codeql/extensions/sofa-jraft-java`` - model pack
- ``models``
- ``jmh-core.model.yml`` - model of calls to the ``jmh-core@1.20`` dependency.
- ``rocksdbjni.model.yml`` - model of calls to the ``rocksdbjni@7.7.3`` dependency.
.. code-block::
.github/codeql/extensions/sofa-jraft-java # the model pack directory
models
jmh-core.model.yml # models calls to jmh-core@1.20
rocksdbjni.model.yml # models calls to rocksdbjni@7.7.3
Modeling the public API of a codebase
-------------------------------------
@@ -103,10 +105,12 @@ The models are stored in your workspace at ``.github/codeql/extensions/<codeql-m
The models are stored in a series of YAML data extension files, one for each public method. For example:
- ``.github/codeql/extensions/sofa-jraft-java`` - model pack
- ``models``
- ``com.alipay.sofa.jraft.option.model.yml`` - model of public methods in this Java package.
- ``com.alipay.sofa.jraft.rhea.options.model.yml`` - model of public methods in this Java package.
.. code-block::
.github/codeql/extensions/sofa-jraft-java # the model pack directory
models
com.alipay.sofa.jraft.option.model.yml # models public methods in package
com.alipay.sofa.jraft.rhea.options.model.yml # models public methods in package
The editor will create a separate model file for each package that you model.