diff --git a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst index 6ffe08708bd..bc59af7b2fb 100644 --- a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst @@ -64,9 +64,9 @@ You can also specify: see `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 `." + see ":doc:`Including query help for custom CodeQL queries in SARIF 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 `." +so must be converted to markdown before running the analysis. For more information, see +":ref:`Testing query help files `." Results -------