Skip to content

Commit c94bfc3

Browse files
committed
improve links
1 parent 5ea93d6 commit c94bfc3

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -219,13 +219,16 @@ alerts generated by the custom queries.
219219
From CodeQL CLI 2.7.1 onwards, you can include markdown-rendered query help in SARIF files
220220
by providing the ``--sarif-add-query-help`` option when running
221221
``codeql database analyze``.
222+
For more information, see `Configuring CodeQL CLI in your CI system <https://docs.github.com/en/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database>`
223+
in the GitHub documentation.
222224

223-
You can write query help for custom queries directly in markdown file and save it alongside the
225+
You can write query help for custom queries directly in a markdown file and save it alongside the
224226
corresponding query. Alternatively, for consistency with the standard CodeQL queries,
225-
you can write query help in the ``.qhelp`` format and convert it to markdown before
226-
running the analysis. Query help written in ``.qhelp`` files can't be included in SARIF files,
227-
and they can't be processed by code scanning. For more information, see
228-
":doc:`Testing query help files <testing-query-help-files>`."
227+
you can write query help in the ``.qhelp`` format. Query help written in ``.qhelp``
228+
files can't be included in SARIF files, and they can't be processed by code
229+
scanning so must be converted to markdown before running
230+
the analysis. For more information, see ":doc:`Query help files <query-help-files>`"
231+
and ":doc:`Testing query help files <testing-query-help-files>`."
229232

230233
Results
231234
-------

0 commit comments

Comments
 (0)