Skip to content

Commit ec5435b

Browse files
Apply suggestions from code review
Co-authored-by: Shati Patel <[email protected]>
1 parent 286c102 commit ec5435b

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/codeql/codeql-cli/about-ql-packs.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,11 @@ The following properties are supported in ``qlpack.yml`` files.
111111
codeql/cpp-all: ^0.0.2
112112

113113
- Packs that define CodeQL package dependencies on other packs
114-
- A map from pack references to the semantic version range that is compatible with this pack.
114+
- A map from pack references to the semantic version range that is compatible with this pack. Supported from CLI version v2.6.0 and onwards.
115115
* - ``defaultSuiteFile``
116116
- ``defaultSuiteFile: cpp-code-scanning.qls``
117117
- Packs that export a set of default queries to run
118-
- The path to a query suite file containing all of the queries that are run by default when this pack is passed to the ``codeql database analyze` command.
118+
- The path to a query suite file containing all of the queries that are run by default when this pack is passed to the ``codeql database analyze`` command. Supported from CLI version v2.6.0 and onwards.
119119

120120
.. _custom-ql-packs:
121121

@@ -183,11 +183,11 @@ Each of the languages in the CodeQL repository has four main QL packs:
183183
used by the language, and CodeQL libraries, and queries at ``ql/<language>/ql/lib``
184184
- Core query pack for the language that includes the default queries for the language, along
185185
with their query suites at ``ql/<language>/ql/src``
186-
- Tests for the core language libraries and queries pack at ``ql/<language>/ql/test``
186+
- Tests for the core language libraries and queries at ``ql/<language>/ql/test``
187187
- Upgrade scripts for the language at ``ql/<language>/upgrades``
188188

189189
Core library pack
190-
~~~~~~~~~~~~
190+
~~~~~~~~~~~~~~~~~
191191

192192
The ``qlpack.yml`` file for a core library pack uses the following properties:
193193
``name``, ``version``, ``dbscheme``.
@@ -207,7 +207,7 @@ contains:
207207
codeql/cpp-upgrades: "*"
208208
209209
Core query pack
210-
~~~~~~~~~~~~
210+
~~~~~~~~~~~~~~~
211211

212212
The ``qlpack.yml`` file for a core query pack uses the following properties:
213213
``name``, ``version``, ``suites``, ``defaultSuiteFile``, ``dependencies`` .
@@ -230,7 +230,7 @@ Tests for the core QL pack
230230
~~~~~~~~~~~~~~~~~~~~~~~~~~
231231

232232
The ``qlpack.yml`` file for the tests for the core QL packs use the following
233-
properties: ``name``, ``version``, and ``libraryPathDependencies``.
233+
properties: ``name``, ``version``, and ``dependencies``.
234234
The ``dependencies`` always specifies the core QL pack.
235235

236236
For example, the ``qlpack.yml`` file for `C/C++ analysis tests
@@ -245,8 +245,6 @@ contains:
245245
codeql/cpp-all: "*"
246246
codeql/cpp-queries: "*"
247247
248-
Notice that, unlike the example QL pack for custom tests, this file does not define
249-
an ``extractor`` or ``tests`` property. These properties have been added to
250248
the QL pack file since the release of CodeQL CLI 2.0.1.
251249
They haven't been added yet to ensure compatibility for LGTM Enterprise users.
252250
After the next release of LGTM Enterprise, these files can be updated.

0 commit comments

Comments
 (0)