From 3bfa8681057459964464f59201a5bfc2acdfe2c2 Mon Sep 17 00:00:00 2001 From: james Date: Thu, 4 Nov 2021 09:53:32 +0000 Subject: [PATCH] add new option to database analyze tutorial --- .../codeql-cli/analyzing-databases-with-the-codeql-cli.rst | 5 +++++ 1 file changed, 5 insertions(+) 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 effc34f3a1d..0ea124501e1 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 @@ -63,6 +63,11 @@ You can also specify: language to the GitHub code scanning API. For more information about this use case, 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. For each query that runs, CodeQL command + replaces the ``.ql`` extension of the query file with ``.md``. If the .md file exists, + its contents are treated as Markdown-formatted help text for the query and included in the SARIF output. + - .. include:: ../reusables/threads-query-execution.rst