Skip to content

Commit 8ca80d3

Browse files
committed
Update links to CodeQL manual
Make CodeQL CLI a single item in the side navigation
1 parent 205bb76 commit 8ca80d3

File tree

6 files changed

+10
-9
lines changed

6 files changed

+10
-9
lines changed

docs/codeql/codeql-cli/codeql-cli-reference.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _codeql-cli-reference:
22

3+
:orphan:
4+
35
CodeQL CLI reference
46
====================
57

docs/codeql/codeql-cli/index.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,9 @@ CodeQL CLI
1010

1111
- `CodeQL CLI reference <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference>`__: Learn more about the files you can use when running CodeQL processes and the results format and exit codes that CodeQL generates.
1212

13-
- `CodeQL CLI manual <manual>`__: Detailed information about all the commands available with the CodeQL CLI.
13+
- `CodeQL CLI manual <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual>`__: Detailed information about all the commands available with the CodeQL CLI.
1414

1515
.. toctree::
1616
:titlesonly:
1717
:hidden:
1818

19-
using-the-codeql-cli
20-
codeql-cli-reference
21-
CodeQL CLI manual <https://codeql.github.com/docs/codeql-cli/manual>

docs/codeql/codeql-cli/using-the-codeql-cli.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _using-the-codeql-cli:
22

3+
:orphan:
4+
35
Using the CodeQL CLI
46
====================
57

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
@@ -153,7 +153,7 @@ To use standard code navigation features in the source code, you can right-click
153153

154154
If you're using an older database, code navigation commands such as **Go to Definition** and **Go to References** may not work.
155155
To use code navigation, try unzipping the database and running ``codeql database cleanup <database>`` on the unzipped database using the CodeQL CLI. Then, re-add the database to Visual Studio Code.
156-
For more information, see the `database cleanup <../../codeql-cli/manual/database-cleanup>`__ reference documentation.
156+
For more information, see `database cleanup <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/database-cleanup>`__ in the documentation for CodeQL CLI.
157157

158158
Comparing query results
159159
------------------------

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Configuring settings for testing queries locally
112112

113113
To increase the number of threads used for testing queries, you can update the **Running Tests > Number Of Threads** setting.
114114

115-
To pass additional arguments to the CodeQL CLI when running tests, you can update the **Running Tests > Additional Test Arguments** setting. For more information about the available arguments, see "`test run <https://codeql.github.com/docs/codeql-cli/manual/test-run/>`_" in the CodeQL CLI help.
115+
To pass additional arguments to the CodeQL CLI when running tests, you can update the **Running Tests > Additional Test Arguments** setting. For more information about the available arguments, see `test run <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/test-run/>`_ in the documentation for CodeQL CLI.
116116

117117
Configuring settings for telemetry and data collection
118118
--------------------------------------------------------

docs/codeql/reusables/advanced-query-execution.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli#including-query-metadata>`__. You can also execute queries using the following
55
plumbing-level subcommands:
66

7-
- `database run-queries <../manual/database-run-queries>`__, which
7+
- `database run-queries <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/database-run-queries>`__, which
88
outputs non-interpreted results in an intermediate binary format called
99
:ref:`BQRS <bqrs-file>`.
10-
- `query run <../manual/query-run>`__, which will output BQRS files, or print
10+
- `query run <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/query-run>`__, which will output BQRS files, or print
1111
results tables directly to the command line. Viewing results directly in
1212
the command line may be useful for iterative query development using the CLI.
1313

1414
Queries run with these commands don't have the same metadata requirements.
1515
However, to save human-readable data you have to process each BQRS results
16-
file using the `bqrs decode <../manual/bqrs-decode>`__ plumbing
16+
file using the `bqrs decode <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/bqrs-decode>`__ plumbing
1717
subcommand. Therefore, for most use cases it's easiest to use ``database
1818
analyze`` to directly generate interpreted results.

0 commit comments

Comments
 (0)