Skip to content

Update links to CodeQL manual in the codeql.github.com site #12967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/codeql/codeql-cli/codeql-cli-reference.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _codeql-cli-reference:

:orphan:

CodeQL CLI reference
====================

Expand Down
5 changes: 1 addition & 4 deletions docs/codeql/codeql-cli/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,9 @@ CodeQL CLI

- `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.

- `CodeQL CLI manual <manual>`__: Detailed information about all the commands available with the CodeQL CLI.
- `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.

.. toctree::
:titlesonly:
:hidden:

using-the-codeql-cli
codeql-cli-reference
CodeQL CLI manual <https://codeql.github.com/docs/codeql-cli/manual>
2 changes: 2 additions & 0 deletions docs/codeql/codeql-cli/using-the-codeql-cli.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _using-the-codeql-cli:

:orphan:

Using the CodeQL CLI
====================

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ To use standard code navigation features in the source code, you can right-click

If you're using an older database, code navigation commands such as **Go to Definition** and **Go to References** may not work.
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.
For more information, see the `database cleanup <../../codeql-cli/manual/database-cleanup>`__ reference documentation.
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.

Comparing query results
------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Configuring settings for testing queries locally

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

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.
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.

Configuring settings for telemetry and data collection
--------------------------------------------------------
Expand Down
18 changes: 0 additions & 18 deletions docs/codeql/reusables/advanced-query-execution.rst

This file was deleted.