Skip to content

Commit c33c5ed

Browse files
committed
Update codeql-cli links
1 parent 465a3e0 commit c33c5ed

File tree

10 files changed

+14
-14
lines changed

10 files changed

+14
-14
lines changed

docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ If you have a CodeQL database saved locally, as an unarchived folder or as a ZIP
3232
- To create a database with the CodeQL CLI, see "`Creating CodeQL databases <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases>`__."
3333

3434
- To analyze a test database, add a ``.testproj`` folder to the Databases view.
35-
Test databases (that is, folders with a ``.testproj`` extension) are generated when you run regression tests on custom queries using the :ref:`CodeQL CLI <codeql-cli>`.
35+
Test databases (that is, folders with a ``.testproj`` extension) are generated when you run regression tests on custom queries using the CodeQL CLI.
3636
If a query fails a regression test, you may want to analyze the test database in Visual Studio Code to debug the failure.
3737

3838
For more information about running query tests, see "`Testing custom queries <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries>`__" in the CodeQL CLI help.

docs/codeql/codeql-for-visual-studio-code/customizing-settings.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ Further reading
8080
----------------
8181

8282
- `User and workspace settings <https://code.visualstudio.com/docs/getstarted/settings>`__ in the Visual Studio Code help
83-
- ":ref:`CodeQL CLI <codeql-cli>`"
83+
- "`CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__"

docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Configuring access to the CodeQL CLI
2828

2929
The extension uses the CodeQL CLI to compile and run queries.
3030

31-
If you already have the CLI installed and added to your ``PATH``, the extension uses that version. This might be the case if you create your own CodeQL databases instead of downloading them from GitHub.com. For more information, see ":ref:`CodeQL CLI <codeql-cli>`."
31+
If you already have the CLI installed and added to your ``PATH``, the extension uses that version. This might be the case if you create your own CodeQL databases instead of downloading them from GitHub.com. For more information, see `CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__."
3232

3333
Otherwise, the extension automatically manages access to the executable of the CLI for you. This ensures that the CLI is compatible with the CodeQL extension. You can also check for updates with the **CodeQL: Check for CLI Updates** command.
3434

@@ -102,4 +102,4 @@ Further reading
102102
----------------
103103

104104
* ":doc:`Analyzing your projects <analyzing-your-projects>`"
105-
* ":ref:`CodeQL CLI <codeql-cli>`"
105+
* "`CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__"

docs/codeql/codeql-language-guides/codeql-library-for-typescript.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Ambient nodes are mostly ignored by control flow and data flow analysis. The out
177177
Static type information
178178
-----------------------
179179

180-
Static type information and global name binding is available for projects with "full" TypeScript extraction enabled. This option is enabled by default when you create databases with the :ref:`CodeQL CLI <codeql-cli>`.
180+
Static type information and global name binding is available for projects with "full" TypeScript extraction enabled. This option is enabled by default when you create databases with the CodeQL CLI.
181181

182182
Basic usage
183183
~~~~~~~~~~~

docs/codeql/codeql-overview/about-codeql.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ After you've created a CodeQL database, one or more queries are executed
7171
against it. CodeQL queries are written in a specially-designed object-oriented
7272
query language called QL. You can run the queries checked out from the CodeQL
7373
repo (or custom queries that you've written yourself) using the :ref:`CodeQL
74-
for VS Code extension <codeql-for-visual-studio-code>` or the :ref:`CodeQL CLI
75-
<codeql-cli>`. For more information about queries, see ":ref:`About CodeQL queries <about-codeql-queries>`."
74+
for VS Code extension <codeql-for-visual-studio-code>` or the `CodeQL CLI
75+
<https://docs.github.com/en/code-security/codeql-cli>`__. For more information about queries, see ":ref:`About CodeQL queries <about-codeql-queries>`."
7676

7777
.. _interpret-query-results:
7878

docs/codeql/codeql-overview/codeql-tools.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The CodeQL command-line interface (CLI) is primarily used to create databases fo
1515
security research. You can also query CodeQL databases directly from the command line
1616
or using the Visual Studio Code extension.
1717
The CodeQL CLI can be downloaded from `GitHub releases <https://github.com/github/codeql-cli-binaries/releases>`__.
18-
For more information, see ":ref:`CodeQL CLI <codeql-cli>`" and the `CLI changelog <https://github.com/github/codeql-cli-binaries/blob/main/CHANGELOG.md>`__.
18+
For more information, see "`CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__" and the `CLI changelog <https://github.com/github/codeql-cli-binaries/blob/main/CHANGELOG.md>`__.
1919

2020
CodeQL packs
2121
-----------------------------

docs/codeql/ql-language-reference/ql-language-specification.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ added to the library path, the CodeQL packs named in its
7474
path, and the process continues until all packs have been
7575
resolved. The actual library path consists of the root directories of
7676
the selected CodeQL packs. This process depends on a mechanism for finding
77-
CodeQL packs by pack name and version, as described in the :ref:`CodeQL CLI documentation <codeql-cli>`.
77+
CodeQL packs by pack name and version, as described in the `CodeQL CLI documentation <https://docs.github.com/en/code-security/codeql-cli>`__.
7878

7979
When the query directory contains neither a ``qlpack.yml`` nor
8080
``codeql-pack.yml`` file, it is considered to be a CodeQL pack with no name and

docs/codeql/writing-codeql-queries/about-codeql-queries.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ CodeQL includes queries to find the most relevant and interesting problems for e
1313
- **Alert queries**: queries that highlight issues in specific locations in your code.
1414
- **Path queries**: queries that describe the flow of information between a source and a sink in your code.
1515

16-
You can add custom queries to `CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs>`__ to analyze your projects with "`Code scanning <https://docs.github.com/en/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning>`__", use them to analyze a database with the ":ref:`CodeQL CLI <codeql-cli>`," or you can contribute to the standard CodeQL queries in our `open source repository on GitHub <https://github.com/github/codeql>`__.
16+
You can add custom queries to `CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs>`__ to analyze your projects with "`Code scanning <https://docs.github.com/en/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning>`__", use them to analyze a database with the "`CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__," or you can contribute to the standard CodeQL queries in our `open source repository on GitHub <https://github.com/github/codeql>`__.
1717

1818
This topic is a basic introduction to query files. You can find more information on writing queries for specific programming languages in the ":ref:`CodeQL language guides <codeql-language-guides>`," and detailed technical information about QL in the ":ref:`QL language reference <ql-language-reference>`."
1919
For more information on how to format your code when contributing queries to the GitHub repository, see the `CodeQL style guide <https://github.com/github/codeql/blob/main/docs/ql-style-guide.md>`__.
@@ -47,14 +47,14 @@ Query metadata
4747
Query metadata is used to identify your custom queries when they are added to the GitHub repository or used in your analysis. Metadata provides information about the query's purpose, and also specifies how to interpret and display the query results. For a full list of metadata properties, see ":doc:`Metadata for CodeQL queries <metadata-for-codeql-queries>`." The exact metadata requirement depends on how you are going to run your query:
4848

4949
- If you are contributing a query to the GitHub repository, please read the `query metadata style guide <https://github.com/github/codeql/blob/main/docs/query-metadata-style-guide.md>`__.
50-
- If you are analyzing a database using the :ref:`CodeQL CLI <codeql-cli>`, your query metadata must contain ``@kind``.
50+
- If you are analyzing a database using the `CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__, your query metadata must contain ``@kind``.
5151
- If you are running a query with the CodeQL extension for VS Code, metadata is not mandatory. However, if you want your results to be displayed as either an 'alert' or a 'path', you must specify the correct ``@kind`` property, as explained below. For more information, see ":ref:`Analyzing your projects <analyzing-your-projects>`" in the CodeQL for VS Code help.
5252

5353
.. pull-quote::
5454

5555
Note
5656

57-
Queries that are contributed to the open source repository, or used to analyze a database with the :ref:`CodeQL CLI <codeql-cli>` must have a query type (``@kind``) specified. The ``@kind`` property indicates how to interpret and display the results of the query analysis:
57+
Queries that are contributed to the open source repository, or used to analyze a database with the CodeQL CLI must have a query type (``@kind``) specified. The ``@kind`` property indicates how to interpret and display the results of the query analysis:
5858

5959
- Alert query metadata must contain ``@kind problem`` to identify the results as a simple alert.
6060
- Path query metadata must contain ``@kind path-problem`` to identify the results as an alert documented by a sequence of code locations.

docs/codeql/writing-codeql-queries/creating-path-queries.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This topic provides information on how to structure a path query file so you can
1818

1919
Note
2020

21-
The alerts generated by path queries are included in the results generated using the :ref:`CodeQL CLI <codeql-cli>` and in `code scanning <https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details>`__. You can also view the path explanations generated by your path query in the :ref:`CodeQL extension for VS Code <codeql-for-visual-studio-code>`.
21+
The alerts generated by path queries are included in the results generated using the `CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__ and in `code scanning <https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details>`__. You can also view the path explanations generated by your path query in the :ref:`CodeQL extension for VS Code <codeql-for-visual-studio-code>`.
2222

2323

2424
To learn more about modeling data flow with CodeQL, see ":doc:`About data flow analysis <about-data-flow-analysis>`."

docs/codeql/writing-codeql-queries/defining-the-results-of-a-query.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ About query results
1010

1111
The information contained in the results of a query is controlled by the ``select`` statement. Part of the process of developing a useful query is to make the results clear and easy for other users to understand.
1212
When you write your own queries in the CodeQL :ref:`extension for VS Code <codeql-for-visual-studio-code>` there are no constraints on what can be selected.
13-
However, if you want to use a query to create alerts for code scanning or generate valid analysis results using the :ref:`CodeQL CLI <codeql-cli>`, you'll need to make the ``select`` statement report results in the required format.
13+
However, if you want to use a query to create alerts for code scanning or generate valid analysis results using the `CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__, you'll need to make the ``select`` statement report results in the required format.
1414
You must also ensure that the query has the appropriate metadata properties defined.
1515
This topic explains how to write your select statement to generate helpful analysis results.
1616

0 commit comments

Comments
 (0)