hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-01-28 05:42:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

improve description of new option

Browse Source
This commit is contained in:
james
2021-11-04 12:41:30 +00:00
parent af0f32fdb6
commit 7236f3b4b6
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst
View File

@@ -64,9 +64,9 @@ You can also specify:
see `Configuring CodeQL CLI in your CI system <https://docs.github.com/en/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system>`__ in the GitHub documentation.
- ``--sarif-add-query-help``: (supported in version 2.7.1 onwards) adds any custom query help written
in Markdown to SARIF (v2.1.0 or later) analysis results. Query help stored in ``.qhelp`` files must be
in markdown to SARIF files (v2.1.0 or later) generated by the analysis. Query help stored in ``.qhelp`` files must be
converted to ``.md`` before running the analysis. For further information,
see ":doc:`Testing query help files <testing-query-help-files>`."
see ":doc:`Including query help for custom CodeQL queries in SARIF files <testing-query-help-files>`."
- .. include:: ../reusables/threads-query-execution.rst
@@ -218,8 +218,8 @@ in SARIF files generated during an analysis.
For CodeQL CLI 2.7.1 onwards, you can include markdown-rendered query help in SARIF files
by providing the ``--sarif-add-query-help`` option when running
``codeql database analyze``. Query help written in ``.qhelp`` files cannot be include in SARIF files,
somust be converted to markdown before running the analysis. For more information, see
":doc:`Testing query help files <testing-query-help-files>`."
so must be converted to markdown before running the analysis. For more information, see
":ref:`Testing query help files <testing-query-help-files>`."
Results
-------