Skip to content

Commit 7607e67

Browse files
aeisenbergjf205
andauthored
Apply suggestions from code review
Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>
1 parent 027365c commit 7607e67

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

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

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ When you run ``database analyze``, it:
3838

3939
You can analyze a database by running the following command::
4040

41-
codeql database analyze <database> --format=<format> --output=<output> ...<query-specifiers>
41+
codeql database analyze <database> --format=<format> --output=<output> <query-specifiers>...
4242

4343

4444
You must specify:
@@ -56,8 +56,8 @@ You must specify:
5656

5757
You can also specify:
5858

59-
- ``...<query-specifiers>``: a list of queries to run over your database. This
60-
is a list of arguments. Where each argument can be:
59+
- ``<query-specifiers>...``: a spece-separated list of queries to run over your database. This
60+
is a list of arguments, where each argument can be:
6161

6262
- a path to a query file
6363
- a path to a directory containing query files
@@ -99,14 +99,13 @@ You can also specify:
9999
For full details of all the options you can use when analyzing databases, see
100100
the `database analyze reference documentation <../manual/database-analyze>`__.
101101

102-
.. _database-analyze-examples:
103102

104103
.. _specifying-which-queries:
105104

106105
Specifying which queries to run in a CodeQL pack
107106
------------------------------------------------
108107

109-
*Query specifiers* are used by ``codeql database analyze`` and other commands that operate on a set of queries.
108+
Query specifiers are used by ``codeql database analyze`` and other commands that operate on a set of queries.
110109
The complete way to specify a set of queries is in the form ``scope/name@range:path``, where:
111110

112111
- ``scope/name`` is the qualified name of a CodeQL pack.
@@ -129,7 +128,7 @@ be absolute. It is considered relative to the root of the CodeQL
129128
pack.
130129

131130
Example query specifiers
132-
------------------------
131+
~~~~~~~~~~~~~~~~~~~~~~~~
133132

134133
* ``codeql/python-queries`` - All the queries in the default query suite of the latest version of the ``codeql/python-queries`` pack.
135134
* ``codeql/python-queries@1.2.3`` - All the queries in the default query suite of version ``1.2.3`` of the ``codeql/python-queries`` pack.
@@ -243,10 +242,8 @@ Query suites in the core CodeQL query packs are all stored in the ``codeql-suite
243242
* ``cpp-code-scanning.qls`` - Standard Code Scanning queries for C++.
244243
* ``cpp-security-and-quality`` - Security-and-quality queries for C++.
245244
* ``cpp-security-extended`` - Security-extended queries for C++. This suite contains queries that are less precise than the standard security queries, and may find more false-positives.
246-
* ``cpp-lgtm.qls`` - Standard LGTM queries for C++.
247-
* ``cpp-lgtm-full.qls`` - Standard LGTM queries for C++, including less precise queries.
248245

249-
You can see the sources for these query suites in the `CodeQL repository <https://github.com/github/codeql/tree/main/cpp/ql/src/codeql-suites>`. Query suites for other languages are similar.
246+
You can see the sources for these query suites in the `CodeQL repository <https://github.com/github/codeql/tree/main/cpp/ql/src/codeql-suites>`__. Query suites for other languages are similar.
250247

251248
For information about creating custom query suites, see ":doc:`Creating
252249
CodeQL query suites <creating-codeql-query-suites>`."

0 commit comments

Comments
 (0)