Skip to content

Commit b52b158

Browse files
Apply suggestions from code review
Co-authored-by: Aditya Sharad <[email protected]>
1 parent 4a8b71a commit b52b158

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,12 @@ see ":doc:`Using custom queries with the CodeQL CLI <using-custom-queries-with-t
111111
Running GitHub code scanning suites
112112
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113113

114-
To run the GitHub code scanning suite of queries over a CodeQL datbase for a C/C++ codebase,
114+
To run the GitHub code scanning suite of queries over a CodeQL database for a C/C++ codebase,
115115
you could use the following command from the directory containing your database::
116116

117-
codeql database analyze <cpp-database> cpp-code-scanning.qls --format=sarifv2.1.0 --output=cpp-analysis/cpp-results.sarif
117+
codeql database analyze <cpp-database> cpp-code-scanning.qls --format=sarifv2.1.0 --output=cpp-results.sarif
118118

119-
The analysis generates a file in the v2.1 SARIF format that is supported by all versions of GitHub.
119+
The analysis generates a file in the v2.1.0 SARIF format that is supported by all versions of GitHub.
120120
This file can be uploaded to GitHub using ``github upload-results`` or the code scanning API.
121121
For more information, see `Analyzing a CodeQL database <https://docs.github.com/en/code-security/secure-coding/configuring-codeql-cli-in-your-ci-system#analyzing-a-codeql-database>`__
122122
or `Code scanning API <https://docs.github.com/en/rest/reference/code-scanning>`__ in the GitHub documentation.

docs/codeql/codeql-cli/creating-codeql-databases.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ more than one language:
5353
- ``--db-cluster``: use for multi-language codebases when you want to create
5454
databases for more than one language.
5555
- ``--command``: used when you create a database for one or more compiled languages,
56-
omit if the only langauges requested are Python and JavaScript.
56+
omit if the only languages requested are Python and JavaScript.
5757
This specifies the build commands needed to invoke the compiler.
5858
Commands are run from the current folder, or ``--source-root``
5959
if specified. If you don't include a ``--command``, CodeQL will attempt to
@@ -76,7 +76,7 @@ build system.
7676

7777
When the database is successfully created, you'll find a new directory at the
7878
path specified in the command. If you used the ``--db-cluster`` option to create
79-
more than one database, a subdirectory is created for each langauge.
79+
more than one database, a subdirectory is created for each language.
8080
Each CodeQL database directory contains a number of
8181
subdirectories, including the relational data (required for analysis) and a
8282
source archive---a copy of the source files made at the time the database was
@@ -98,8 +98,7 @@ are available.
9898
specify a ``--command`` option. Otherwise this overrides the normal
9999
extractor invocation, which will create an empty database. If you create
100100
databases for multiple languages and one of them is a compiled language,
101-
use the ``--no-run-unnecessary-builds`` option to skip the command for these
102-
languages.
101+
use the ``--no-run-unnecessary-builds`` option to skip the command for the languages that don't need to be compiled.
103102

104103
JavaScript and TypeScript
105104
~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)