From b52b158c972c98c6dbd8584f676533632f145781 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Mon, 28 Jun 2021 12:20:20 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com> --- .../codeql-cli/analyzing-databases-with-the-codeql-cli.rst | 6 +++--- docs/codeql/codeql-cli/creating-codeql-databases.rst | 7 +++---- 2 files changed, 6 insertions(+), 7 deletions(-) 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 76fdd296db1..d4e242ede3e 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 @@ -111,12 +111,12 @@ see ":doc:`Using custom queries with the CodeQL CLI cpp-code-scanning.qls --format=sarifv2.1.0 --output=cpp-analysis/cpp-results.sarif + codeql database analyze cpp-code-scanning.qls --format=sarifv2.1.0 --output=cpp-results.sarif -The analysis generates a file in the v2.1 SARIF format that is supported by all versions of GitHub. +The analysis generates a file in the v2.1.0 SARIF format that is supported by all versions of GitHub. This file can be uploaded to GitHub using ``github upload-results`` or the code scanning API. For more information, see `Analyzing a CodeQL database `__ or `Code scanning API `__ in the GitHub documentation. diff --git a/docs/codeql/codeql-cli/creating-codeql-databases.rst b/docs/codeql/codeql-cli/creating-codeql-databases.rst index 2eba1005281..3943aa87196 100644 --- a/docs/codeql/codeql-cli/creating-codeql-databases.rst +++ b/docs/codeql/codeql-cli/creating-codeql-databases.rst @@ -53,7 +53,7 @@ more than one language: - ``--db-cluster``: use for multi-language codebases when you want to create databases for more than one language. - ``--command``: used when you create a database for one or more compiled languages, - omit if the only langauges requested are Python and JavaScript. + omit if the only languages requested are Python and JavaScript. This specifies the build commands needed to invoke the compiler. Commands are run from the current folder, or ``--source-root`` if specified. If you don't include a ``--command``, CodeQL will attempt to @@ -76,7 +76,7 @@ build system. When the database is successfully created, you'll find a new directory at the path specified in the command. If you used the ``--db-cluster`` option to create -more than one database, a subdirectory is created for each langauge. +more than one database, a subdirectory is created for each language. Each CodeQL database directory contains a number of subdirectories, including the relational data (required for analysis) and a source archive---a copy of the source files made at the time the database was @@ -98,8 +98,7 @@ are available. specify a ``--command`` option. Otherwise this overrides the normal extractor invocation, which will create an empty database. If you create databases for multiple languages and one of them is a compiled language, - use the ``--no-run-unnecessary-builds`` option to skip the command for these - languages. + use the ``--no-run-unnecessary-builds`` option to skip the command for the languages that don't need to be compiled. JavaScript and TypeScript ~~~~~~~~~~~~~~~~~~~~~~~~~