Skip to content

Commit 7be0b2e

Browse files
committed
Fix Sphinx bugs
1 parent 8c8bbde commit 7be0b2e

File tree

4 files changed

+14
-11
lines changed

4 files changed

+14
-11
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,10 @@ To set up the CodeQL model editor, you need to be using CodeQL for VS Code 1.8.7
3030

3131
.. code-block:: json
3232
33-
"codeQL.canary": true, CHECK THIS
34-
"codeQL.model.editor": true,
33+
"codeQL.canary": true,
34+
"codeQL.model.editor": true,
35+
36+
CHECK THIS ^^^
3537

3638
Open the user settings editor (JSON) using the command palette (Ctrl/Cmd+Shift+P) and using the command “Preferences: Open User Settings (JSON)”, add these two settings to the file.
3739

docs/codeql/codeql-language-guides/data-extensions-to-model-java-dependencies.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Data extensions use union semantics, which means that the tuples of all extensio
5050
Publish data extension files in a CodeQL model pack to share
5151
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5252

53-
You can group one or more data extention files into a CodeQL model pack and publish it to the GitHub Container Registry. This makes it easy for anyone to download the model pack and use it to extend their analysis. For more information, see "`Creating a CodeQL model pack <https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs#creating-a-codeql-model-pack>`__ and `Publishing and using CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs`__ in the CodeQL CLI documentation.
53+
You can group one or more data extention files into a CodeQL model pack and publish it to the GitHub Container Registry. This makes it easy for anyone to download the model pack and use it to extend their analysis. For more information, see "`Creating a CodeQL model pack <https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs#creating-a-codeql-model-pack/>`__ and `Publishing and using CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs/>`__ in the CodeQL CLI documentation.
5454

5555
Extensible predicates in the CodeQL library for Java/Kotlin
5656
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -62,14 +62,14 @@ The CodeQL library for Java and Kotlin analysis exposes the following extensible
6262
- ``summaryModel(package, type, subtypes, name, signature, ext, input, output, kind, provenance)``. This is used to summarize how data values from a source flow outside the repository in a dependency of the main code base.
6363
- ``neutralModel(package, type, name, signature, kind, provenance)``. This is similar to a summary model but used to model the flow of values that have only a minor impact on the data flow analysis.
6464

65-
The extensible predicates are populated using data extensions specified in YAML files. For more information about extensible predicates, see ":ref:`extensible-predicates`."
65+
The extensible predicates are populated using data extensions specified in YAML files. For more information about extensible predicates, see ":doc:`extensible-predicates`."
6666

6767
Examples of data extension definitions
6868
--------------------------------------
6969

7070
The examples in this section are taken from the standard CodeQL Java query pack published by GitHub. They demonstrate how to add tuples to extend extensible predicates that are used by the standard queries.
7171

72-
For details of the *mini DSLs* that define models for each extensible predicate, see ":ref:`extensible-predicate-reference`."
72+
For details of the *mini DSLs* that define models for each extensible predicate, see ":doc:`extensible-predicates`."
7373

7474
Example: Taint sink in the ``java.sql`` package
7575
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/codeql/codeql-language-guides/extensible-predicates.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,12 @@ At a high level, there are two main components to using data extensions. The que
2525
This example of an extensible predicate for a source is taken from the core Java libraries https://github.com/github/codeql/blob/main/java/ql/lib/semmle/code/java/dataflow/ExternalFlowExtensions.qll#L8-L11
2626

2727
.. code-block:: ql
28-
extensible predicate sourceModel(
29-
string package, string type, boolean subtypes, string name,
30-
string signature, string ext, string output, string kind,
31-
string provenance
32-
);
28+
29+
extensible predicate sourceModel(
30+
string package, string type, boolean subtypes, string name,
31+
string signature, string ext, string output, string kind,
32+
string provenance
33+
);
3334
3435
An extensible predicate is a CodeQL predicate with the following restrictions:
3536

docs/codeql/codeql-overview/codeql-glossary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ CodeQL packs
4141

4242
CodeQL packs are used to create, share, depend on, and run CodeQL queries, libraries, and models. You can publish your own CodeQL packs and download packs created by others. CodeQL query packs may contain queries, library files, query suites, and metadata. CodeQL library packs include one or more CodeQL libraries. CodeQL model packs include one or more data extension files that extend the core libraries by modeling additional libraries and frameworks (dependencies of your code base).
4343

44-
.. _data-extensions::
44+
.. _data-extensions:
4545

4646
Data extensions
4747
---------------

0 commit comments

Comments
 (0)